WordPress’ inline documentation efforts really kicked off starting in the 3.7 releaseRelease A release is the distribution of the final version of an application. A software release may be either public or private and generally constitutes the initial or new generation of a new or upgraded application. A release is preceded by the distribution of alpha and then beta versions of the software. cycle, and gained momentum as the hook docs initiative progressed to the present. The inline documentation, or “inline docs” initiative is a hybrid project, reporting to both the coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. development and documentation teams.

OK, so what is inline documentation anyway?

Inline documentation provides both necessary and useful information in the form of inline-comments, phpdoc blocks and more within the source of the WordPress codebase itself.

It is very much considered to be “technical” documentation, so some familiarity with the WordPress codebase will be necessary. You have to be able to understand the code to write about it!

How can I get involved?

Below you’ll find helpful links for getting involved in the Hook Docs initiative, as well as for locating inline docs-related TracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. tickets you can contribute to.

For any questions, feel free to pingPing The act of sending a very small amount of data to an end point. Ping is used in computer science to illicit a response from a target server to test it’s connection. Ping is also a term used by Slack users to @ someone or send them a direct message (DM). Users might say something along the lines of “Ping me when the meeting starts.” @kpdesign or @drewapicture anytime.

Hook Docs Hook Docs

Top ↑

Trac Reports Trac Reports

Top ↑

  • Adam Brown’s Hooks Database (useful for hints on the @since versions of hooksHooks In 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.)