Welcome to the official home of the WordPress documentation team.
This team is responsible for coordinating all documentation initiatives around WordPress, including the Codex (moving to HelpHub and DevHub), handbooks, parts of developer.wordpress.orgWordPress.orgThe community site where WordPress code is created and shared by the users. This is where you can download the source code for WordPress core, plugins and themes as well as the central location for community conversations and organization. https://wordpress.org/, admin help, inline docs, and other general wordsmithing across the WordPress project.
Want to get involved?
There are many ways in which you can help the Docs team. Every small contribution counts and helps! You can report an issue or typo you found in the docs, or even help us write new documentation for parts that are still missing. These are some helpful links to find out more about what we do and how to collaborate:
Block Editor Handbook: An overview of documentation contributions of BlockBlockBlock is the abstract term used to describe units of markup that, composed together, form the content or layout of a webpage using the WordPress editor. The idea combines concepts of what in the past may have achieved with shortcodes, custom HTML, and embed discovery into a single consistent API and user experience. Editor / GutenbergGutenbergThe Gutenberg project is the new Editor Interface for WordPress. The editor improves the process and experience of creating new content, making writing rich content much simpler. It uses ‘blocks’ to add richness rather than shortcodes, custom HTML etc. https://wordpress.org/gutenberg/
Documentation Issue Tracker on GitHub: Submit any DevHub/HelpHub/”Doc Team Handbook” Docs-related issue on GitHubGitHubGitHub is a website that offers online implementation of git repositories that can easily be shared, copied and modified by other developers. Public repositories are free to host, private repositories require a paid subscription. GitHub introduced the concept of the ‘pull request’ where code changes done in branches by contributors can be reviewed and discussed before being merged be the repository owner. https://github.com/.
Weekly Meetings
Join our discussions of documentation issues here on the blog and on Slack.
The styles for the WordPress CodexWordPress CodexLiving online manual to WordPress.org https://codex.wordpress.org/ are different from other wikis. For specifics, see Codex:Styles. The following editing styles and markup cover the specific style of the Codex and includes recommendations and structure formats from MediaWiki’s Guide: Editing Overview. For more information on styling these pages, see:
In the chart below, in the left column of the table below, you can see what effects are possible. In the right column, you can see how those effects were achieved. In other words, to make text look like it looks in the left column, type it in the format you see in the right column.
You may want to keep this page open in a separate browser window for reference. If you want to try out things without danger of doing any harm, you can do so in the Sandbox.
Newline works like this example. First, what it looks like in the editing panel:
A single
newline
has no
effect on the
layout.
But an empty line
starts a new paragraph.
What appears in the edited document is either no line breaks in single lines or a mix of single and double line breaks, creating garbled presentations:
A singlenewline has no effect on the layout.
But an empty line
starts a new paragraph.
(<p> disables this paragraphing until </p> or the end of the section)
If you make a new line without an empty line in between, Mediawiki will show the text in a single line. If you make a “double space” line break after a line, it will create a new paragraph.
Double lines also end lists and indents. See Don’t use line breaks for more information.
(in Cologne Blue two newlines and a div tag give just one newline; in the order newline, div tag, newline, the result is two newlines)
Sufficient as wikitext code is <br />, the XHTML code <br /> is not needed, the system produces this code.
Example:
You can break lines
without starting a new paragraph.<p>
You can break lines<br />
without starting a new paragraph.
* Lists are easy to do:
** start every line with a star
*** more stars means deeper levels
*A newline
*in a list
marks the end of the list.
*Of course
*you can
*start again.
Numbered lists are also good
very organized
easy to follow
A newline
in a list
marks the end of the list.
New numbering starts
with 1.
# Numbered lists are also good
## very organized
## easy to follow
#A newline
#in a list
marks the end of the list.
#New numbering starts
#with 1.
You can even do mixed lists
and nest them
like this
or have newlines
inside lists
* You can even do mixed lists
*# and nest them
*#* like this<br />or have newlines<br />inside lists
You can also
break lines
inside lists
like this
* You can also
**break lines<br />inside lists<br />like this
Definition list
list of definitions
item
the item’s definition
; Definition list : list of definitions
; item : the item's definition
NOTE: Indents are currently not working in the WordPress Codex styles. Indent when appropriate and this should be resolved soon.
A colon indents a line or paragraph.
A manual newline starts a new paragraph.
This is primarily for displayed material, but is also used for discussion on Talk pages.
: A colon indents a line or paragraph.
A manual newline starts a new paragraph.
IF a line of plain text starts with a space THEN
it will be formatted exactly
as typed;
in a fixed-width font;
lines won't wrap;
ENDIF
this is useful for:
* pasting preformatted text;
* algorithm descriptions;
* program source code
* ASCII art;
* chemical structures;
NOTE: Centered Texts are currently not working in the WordPress Codex styles. Center when appropriate and this should be resolved soon.
To center text, use the <center>HTMLHTMLHTML is an acronym for Hyper Text Markup Language. It is a markup language that is used in the development of web pages and websites. tag.
In most cases a section headerHeaderThe header of your site is typically the first thing people will experience. The masthead or header art located across the top of your page is part of the look and feel of your website. It can influence a visitor’s opinion about your content and you/ your organization’s brand. It may also look different on different screen sizes. is more useful. The horizontal dividing line should only be used if what follows is logically part of the same section; otherwise that part would be hidden in the TOC.
First letter of target is automatically capitalized.
Internally spaces are automatically represented as underscores (typing an underscore has the same effect as typing a space, but is not recommended).
Thus the link above is to https://codex.wordpress.org/WordPress_Features, which is the page with the name “WordPress Features”.
Sue is reading about the [[WordPress_Features]].
When linking to another WordPress Codex page, the link does not need the underline in between the words:
[[WordPress Features]]
When linking to a WordPress Codex page from an external source, such as a blog, the underline is required.
To link to a section on a page, e.g. List_of_cities_by_country#Morocco; when section linking does not work the link is treated as link to the page, i.e. to the top; this applies for:
links to non-existent sections
links in redirects
interwiki links
[[List_of_cities_by_country#Morocco]].
It is recommended to reword the links when the link target and link label are different, such as linking to a seciton of linking from within the context of the article.
The server fills in the part after the | when you save the page. Next time you open the edit box you will see the expanded piped link. A preview interprets the abbreviated form correctly, but does not expand it yet in the edit box. Press Save and again Edit, and you will see the expanded version. The same applies for the following feature.
A link to the page on the same subject in another language or, more generally, to a page on another wiki: fr:Wikipédia:Aide. For more info see m:Help:Interwiki linking.
[[Special:Whatlinkshere/Wikipedia:How to edit a
page|Wikipedia:How to edit a page]] and
[[Special:Recentchangeslinked/Wikipedia:How to
edit a page|Wikipedia:How to edit a page]]
External links are set with one bracket and a space between the URLURLA specific web address of a website or web page on the Internet, such as a website’s URL www.wordpress.org and the link title as: WordPress.
Or just give the URL: http://www.wordpress.org if it is very short.
In the URL all symbols must be among: A-Z a-z 0-9 ._\/~%-+&#?!=()@ \x80-\xFF. If a URL contains a different character it should be converted; for example, ^ has to be written %5E (to be looked up in ASCII). A blank space can also be converted into an underscore.
To link to books, you can use ISBN links. ISBN 0123456789X See Help:ISBN links
To add a categoryCategoryThe 'category' taxonomy lets you group posts / content together that share a common bond. Categories are pre-defined and broad ranging. to a page, place the category code at the bottom of the page, taking care to use the exact spelling and format from the Special:Categories list.
[[Category:Category name]]
An example would be:
[[Category:WordPress Lessons]]
Localization: For non-English language documents on the WordPress Codex, please use the two letter language code before the Category Name to group language specific documents:
[[Category:fr:Panneaux_Administration]]
You may also include the language specific category for all documents in that language such as:
[[Category:Turkish Codex]]
Link to a Category: To create a link to a category, use a colon before the word “Category” and add the link text for improved readability such as:
[[:Category:WordPress_Lessons|WordPress Lessons]]
Which will appear in a sentence as:
You can find more helpful information in the WordPress Lessons category on the WordPress Codex.
The weather in London is a page that doesn’t exist yet. If you know the page exists, double check the link to ensure that it is spelled correctly. Do not create a new page to one that already exists.
You can create it by clicking on the link.
To create a new page:
Create a link to it on some other page.
Save that page.
Click on the link you just made. The new page will open for editing.
Have a look at how to start a page guide and the naming conventions page for your project.
[[The weather in London]] is a page that doesn't exist yet.
The WordPress Codex allows links to uploaded images and multimedia files, as well as links to external multimedia files, though these are not recommended. Copyrights are to be protected at all times and copyrighted images and content are not allowed on the WordPress Codex without explicit permission of the owner.
To upload images, use the upload page. You can find the uploaded image on the image list
For layout purposes, you can align the image and have it be thumbnail sized so the user can click the image to see a larger version:
WordPress Default Theme
[[Image:Kubrick_Single.jpg|left|thumbnail|WordPress Default Theme]]
A picture: [[Image:codex-logo-2.png|WordPress Codex Logo]]
The alternate text is required.
[[Image:codex-logo-2.png|WordPress Codex Logo]]
Web browsers render alternate text when not displaying an image — for example, when the image isn’t loaded, or in a text-only browser, or when spoken aloud. See Alternate text for images for help on choosing alternate text. See Extended image syntax for more image options.
NOTE: Currently, right and left floats do not work in the current Codex styles. Hopefully this will be fixed soon, so code for the floats as you edit.
To float the full-size image to the right or left of the text, use:
You can also write italic and bold if the desired effect is a specific font style rather than emphasis, as in mathematical formulas:
F = ma
However, the difference between these two methods is not very important for graphical browsers, and many people choose to ignore it.
You can also write <i>italic</i>
and <b>bold</b> if the desired effect is a
specific font style rather than emphasis, as
in math formulas:
:<b>F</b> = <i>m</i><b>a</b>
Use the typewriter font for technical terms and references.
A typewriter font for
<tt>technical terms</tt>.
You can use small text for captions.
You can use <small>small text</small> for captions.
You can strike out deleted material and underline new material.
You can <strike>strike out deleted material</strike>
and <u>underline new material</u>.
When adding a comment to a Talk page, you should sign it. You can do this by adding three tildes for your user name:
Karl Wick
or four for user name plus date/time:
Karl Wick 08:10 Oct 5, 2002 (UTC)
When adding a comment to a Talk page,
you should sign it. You can do this by
adding three tildes for your user name:
: ~~~
or four for user name plus date/time:
: ~~~~
The latter method of superscript can’t be used in the most general context, but is preferred when possible (as with units of measurement) because most browsers have an easier time formatting lines with it.
Subscript: x<sub>2</sub>
Superscript: x<sup>2</sup> or x²
or in projects with the templates sub and sup:
Subscript: x{{sub|2}}
Superscript: x{{sup|2}}
ε<sub>0</sub> =
8.85 × 10<sup>−12</sup>
C² / J m.
1 [[hectare]] = [[1 E4 m²]]
Use <pre> to suppress interpretation of wiki markup and keep newlines and multiple spaces, and get typewriter font, but interpret character references:
arrow →
<pre>arrow →
</pre>
The same PRE effect can be used with the leading space shortcut. Use leading space on each line to keep newlines and multiple spaces, and get typewriter font:
HTML tables can be quite useful as well. For details on how to use them and discussion about when they are appropriate, see MediaWiki User’s Guide: Using tables.
NOTE: Currently, spacing within tables and some table styles are not working. Hopefully, this will be resolved soon.
By default, the table of contents on a page is generated at the first section heading. Since this might be low down on the page, it is recommended to force the table of contents to appear at the top of the page by typing the following at the top of the page with two underlines or underscores before and after the word TOC.
When moving or copying a piece of text within a page or from another page, and also making other edits, it is useful to separate these edits. This way the diff function can be usefully applied for checking these other edits.
The following are the templates used to designate an article as needing Administrator attention. Action upon these requests can only be done by Administrators.
Deprecated: When a function is deprecated and/or replaced by a new feature, use {{Deprecated}}. It will automatically be added to.
Delete: To mark an article as ready for deletion, use {{rfd}}.
Needs Editing: To mark an article for editing, fact checking, or other attention, use {{Copyedit}}.
Incomplete: To mark an article is too short or incomplete, use {{Stub}}.
Merge Into: To mark an article is recommended to be merged into another article, use {{merge-into|[[PageB]]}} such as {{merge-into|[[This Article]]}}. Add a note to the page’s Discussion to indicate your reasoning. Do not use this to indicate a page needs to be moved. Use Rename.
Rename or Move: To mark an article for a name change or move, use {{Rename}} with the reason and suggestions on the Discussion page.
Old Pages: To mark an article as old or archaic, use WP version: {{Oldpage|WPVersion}}, such as {{Oldpage|1.5}} or by date of “expiration” such as {{Datedpage|Date}}, such as if the page was not updated since March 24, 2006, type {{Datedpage|March 24, 2006}}. Include a note in bold explaining the reason and linking to current versions of the information.
Some text on a page may correspond in the edit box to just a reference to another page, in the form {{name}}, referring to the page “Template:name“. This is called a template. For changing that text, edit that other page. Sometimes a separate edit link is provided for this purpose. A convenient way to put such a link in a template in Wikipedia is with en:Template:ed.
In a few cases the link labeled “Edit this page” is replaced by the text “Protected page” (or equivalents in the language of the project). In that case the page can not be edited.