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.org The 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:

Docs Team Handbook: An overview of what we do and how to collaborate
WordPress Documentation Style Guide: Style guide for WordPress documentation
Block Editor Handbook: An overview of documentation contributions of BlockBlock Block 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 / GutenbergGutenberg The 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/
DevHub (developer.wordpress.org): The home of the developers’ documentation
HelpHub (wordpress.org/documentation): The home for all end-user documentation
Documentation Issue Tracker on GitHub: Submit any DevHub/HelpHub/”Doc Team Handbook” Docs-related issue on GitHubGitHub GitHub 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 documentation team holds weekly office hours on Tuesdays from 14:00-15:00 UTC in the #docs SlackSlack Slack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/. channel.

Although we have a fixed schedule of weekly meetings, you can contact the Docs Team at any time through our Slack channel.

Home / Docs Handbook / Code Reference / Editing Articles

Editing Articles

Codex to Code Reference

As an example, let’s compare two pages of add_action to understand which sections are transferred to which areas:

Codex (archives):
https://codex.wordpress.org/index.php?title=Function_Reference/add_action&oldid=152725

Code Reference:
https://developer.wordpress.org/reference/functions/add_action/

Top ↑

Description, Syntax, Parameters and Returns

The Description, Syntax, Parameters and Returns should be converted to inline docs in the function headerHeader The 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.. These inline docs are automatically converted and added to the Code Reference.

For our example, refer to this source code. https://core.trac.wordpress.org/browser/tags/5.2/src/wp-includes/plugin.php#L384. As you can see, the function header includes description and @since, @param and @return tags. Those tags form the Description, Syntax, and Parameters for this function and have been automatically added to the Code Reference.

All functions already have inline docs but not with the same level of information as the Codex. A lot of information was dropped during initial function header creation.

To add/update inline docs, refer to this page:
https://make.wordpress.org/docs/handbook/code-reference/inline-documentation/. You will need some development skills to build the environment and contribute.

Notes: Inline docs may not have enough syntax or space to describe every detail parameters or returned values. In these cases, use Explanation field.

Top ↑

Usage, Notes and Programming Topics

These should be migrated to the Explanation field of the Code Reference and are displayed in the “More Information” section.

Note: One line Usage such as the following do not need to be migrated due to its triviality.

<?php get_post_comments_feed_link( $post_id, $feed ) ?>

To add/edit the Explanation field, your WordPress.orgWordPress.org The 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/ account need to have an editor role or above added for the Developer Reference. To be added, go to the #docs channel on slack and ask one of the rep on The Team to add you.

Top ↑

Usage Examples

Usage examples are migrated as the User Comments for each page.

Refer to this document for more details: https://make.wordpress.org/docs/handbook/code-reference/editing-articles/migrating-from-codex/

Top ↑

Getting Started

We’re tracking the migrationMigration Moving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies. of the Codex to the Code Reference in this spreadsheet:
https://docs.google.com/spreadsheets/d/15hpEbbnuWJZ0DJafyCeG3CFRMtSxX1gY-RObrrjzzdw/edit#gid=1679372392

Top ↑

First reserve the page where you want to edit.

In the tracking spreadsheet, search for ‘Partially done’ rows using the Status column (Column H).
Enter your name in the Editor column (Column F) and change the Status column (Column H) to ‘In Progress’. If you don’t have write permission to the spreadsheet, please DM your Google account to @atachibana on #docs channel.

Top ↑

Compare Codex and Code Reference

Open Codex page and Code Reference page and compare them
If Code Reference has full information of Codex, then OK
If Code Reference does not have some information, refer above Codex to Code Reference and migrate missing information on the Codex page to the Code Reference appropriately.

When you create a Ticket to modify the inline documentation, change the status to ‘Waiting’, and leave the ticket number in Notes (Column I).
If you cannot migrate every section, leave a comment in the Notes column (Column I) noting what’s left and change the Status to ‘Partially done’.

Top ↑

Redirect the page from Codex to Code Reference.

After the migration complete, redirect codex page to Code Reference.

Top ↑

When the Codex page has a language locator

From the Codex page, click Edit on right side menu.
Put following message below the language locator, and comment out the current Codex contents using .

{{Languages|
{{en|WordPress Features}}
{{ja|WordPress Features}}
}}
This page was moved to https://developer.wordpress.org/reference/functions/(function name)/ except above language locator.

Click Show Preview at the bottom of the page and confirm your changes.
Enter the text “Transferred to DevHub” in the Summary box and click Save page.

Top ↑

When the Codex page does not have a language locator

From the Codex page, click Edit on right side menu.
Put following tag at the top of the page, and adjust the URLURL A specific web address of a website or web page on the Internet, such as a website’s URL www.wordpress.org.

{{#dotorgredirect: https://developer.wordpress.org/reference/functions/(function name)/}}

Enter the text “Transferred to DevHub” in the Summary box and click Save page.

NOTE: Once you save the page, viewing the page will redirect you to the DevHub version of the page. If you want to modify the saved page, add &action=edit to the URL.
e.g. https://codex.wordpress.org/index.php?title=Function_Reference/add_action&action=edit

Top ↑

Release this page

Change the “In Progress” status to “Done” (Column H).

Top ↑

Progress Stats

https://docs.google.com/spreadsheets/d/15hpEbbnuWJZ0DJafyCeG3CFRMtSxX1gY-RObrrjzzdw/edit#gid=1576070270

Last updated: August 24, 2020