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 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.
Note:Highlight: Enclose placeholders in a <var> element and use uppercase characters with underscore delimiters.
Placeholders in code and commands represent values that the user must input or replace. Placeholders in outputs can also represent values that differ. Generally, placeholders have a descriptive name and a value.
For example, POST_ID represents a post ID in a code example, command, and example output. In example output, VERSION represents the version of a plugin, theme, or software; the reader is not expected to set this to a specific value.
This page explains how to format placeholder variables in commands and code examples. For more information about other code-related documentation, see Code in text, Code examples, and Command-line syntax.
For text in placeholder variables, use uppercase characters with underscore delimiters. If using uppercase characters with underscore delimiters, or capitalizing lowercase characters with already uppercase characters seems inconsistent, then it is acceptable to use another convention; but be consistent with that convention.
When you use a placeholder in code examples, commands, or other text, include an explanation for what the placeholder represents. Write an explanation for the first time you use the placeholder; if there are multiple placeholders or steps after the first use of that placeholder, you can explain the placeholder again.
Use the following order to describe placeholders:
– Describe what the user is doing.
– Write the code example, command, or other text.
– Explain the placeholder.
– Explain the code example, command, or other text in more detail if required.
– Show any output if required.
– Explain any output if required.
Example
Tip:Recommended:
<pre class="prototype">
<img
src="<var>IMAGE_PATH</var>"
alt="The WordPress mascot Wapuu."
/>
</pre>
<p>Replace the following:</p>
<ul>
<li><code><var>IMAGE_PATH</var></code>: the directory path of the image asset.</li>
</ul>
When there are two or more placeholders in code examples, commands, or other text, use the following formatting:
– Write a descriptive list of all the placeholder variables used in the respective code example, command, or other text, after the code content.
– Explain what each placeholder variable represents.
– Introduce the placeholder description list with Replace the following:
– List all the placeholder variables in the order in which they appear in the code example, command, or other text.
– Provide a description for each placeholder variable.
– Tag each placeholder with <code><var> elements, followed by a colon and lowercase letter as follows: html
<li><code>PLACEHOLDER</code>: description</li>
Example
Tip:Recommended:
To edit an existing post, enter the following command:
$ wp post edit POST_ID --path=PATH --skip-themes[=THEMES]
Replace the following:
– POST_ID: the ID of the post that you want to edit.
– PATH: the path to the WordPress files.
– THEMES: skip loading all themes, or a comma-separated list of themes.
When you specify placeholders in output examples, use the following formatting:
– Write a descriptive list of all the placeholder variables used in the output, after the output example.
– Introduce the placeholder description list with In this output:
– List all the placeholder variables in the order in which they appear in the output example.
– Provide a description for each placeholder variable.
– Tag each placeholder with <code><var> elements, followed by a colon and lowercase letter as follows: html
<li><code>PLACEHOLDER</code>: description</li>
OAUTH_REQUEST_URL: the OAuth requesting URLURLA specific web address of a website or web page on the Internet, such as a website’s URL www.wordpress.org.