Documentation Issue Tracker on GitHub: Submit any Documentation Team-related issues 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/
Join our discussions of documentation issues here on the blog and on Slack.
Note: This project was completed. Thank you for your contribution.
As outlined in the Codex Migration page, one of our primary contributor efforts as of 2015 is moving examples from Codex articles to their corresponding Code Reference articles. This effort is already in full-swing, and is a great way to contribute in small ways for big results.
Take note, in the above spreadsheet, there are multiple tabs (Functions, Classes, HooksHooksIn WordPress theme and development, hooks are functions that can be applied to an action or a Filter in WordPress. Actions are functions performed when a certain event occurs in WordPress. Filters allow you to modify certain functions. Arguments used to hook both filters and actions look the same., Status), which you can select at the bottom.
In the Functions tab, there are 1,110 functions listed, which constitute all of the functions that currently have a published reference page in the Codex right now. Not all of these pages have examples, but most do.
You might notice that the # Examples column lists “Unknown” for a lot of references — counting examples is a work in progress. Examples don’t need to be pre-counted in order for a reference status to proceed, counting examples was previously used to assist in determining which references could be skipped for migrating examples.
So you want to migrate examples? There are a few simple steps to get started:
You must have a 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/ account. Don’t have one? Create an account.
Some understanding of PHPPHPPHP (recursive acronym for PHP: Hypertext Preprocessor) is a widely-used open source general-purpose scripting language that is especially suited for web development and can be embedded into HTML. http://php.net/manual/en/intro-whatis.php. and 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. is useful but not required.
Visit the Codex article for that function by navigating to the link in the Codex column for the function.
Grok the page to locate any examples. Examples often have corresponding description text leading up to the example code (most have a title, short description and then code, you want all three), so it’s helpful to look for that text when trying to decide how many examples there are.
Copy the example text and code to your clipboard either by right-clicking and selecting “Copy” or with your keyboard using Ctrl + C (Windows) or Cmd + C (Mac).
Back in the spreadsheet, visit the the Code Reference article by navigating to the link in the Reference column for the function.
At the bottom of the reference article in the Code Reference, look for a section called “User Contributed Notes”. There will be a link in that section, “Have a note to contribute?”. Click that link.
Log in with your WordPress.org credentials if you haven’t already.
A form for submitting a user contributed note should appear on your screen. Paste in the code example and text you copied from the Codex. If you feel comfortable, feel free to reformat the example text to provide proper emphasis. For the code example, it’s helpful to the reviewers to substitute any opening and closing PHP tags with
&amp;amp;amp;amp;amp;amp;amp;lt;/code&amp;amp;amp;amp;amp;amp;amp;gt; and &amp;amp;amp;amp;amp;amp;amp;lt;code&amp;amp;amp;amp;amp;amp;amp;gt;
shortcodes – these are used on the front-end view for code syntax highlighting.
When everything has been formatted, click the “Add Note” button.
If there are multiple examples in the Codex article, repeat steps 3-8 until all examples have been submitted.
Once you’ve submitted all of the Codex examples, make sure to update the Status column of the spreadsheet marking the function as “Ready for Review”, then update the # Examples column with the number of submitted examples (this is so reviewers can cross-reference completeness). You may also jot down any notes in the Notes column about notable other stuff that should come over later as an “Explanation” section. A reviewer will follow along later to validate and publish the example(s) you migrated.
All of the submitted examples are vetted before they’re published. Fixing the examples when submitted is a bonus, because it’s less work for the reviewers to do.
Congratulations! If you followed all of the steps above, you will have successfully migrated the examples for a function. Let’s migrate another one!