Title: Inline Docs
Author: Drew Jaynes
Published: January 21, 2014
Last modified: October 21, 2014

---

#  Inline Docs

### Topics

 * [Hook Docs](https://make.wordpress.org/docs/inline-docs/?output_format=md#hook-docs)
 * [Trac Reports](https://make.wordpress.org/docs/inline-docs/?output_format=md#trac-reports)
 * [Other Links](https://make.wordpress.org/docs/inline-docs/?output_format=md#other-links)

WordPress’ inline documentation efforts really kicked off starting in the 3.7 release
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/](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](https://profiles.wordpress.org/kpdesign/)
or [@drewapicture](https://profiles.wordpress.org/drewapicture/) anytime.

### 󠀁[Hook Docs](https://make.wordpress.org/docs/inline-docs/?output_format=md#hook-docs)󠁿

 * [Hook Docs intro post](https://make.wordpress.org/core/2013/09/05/add-inline-docs-for-hooks/)
 * [Inline Documentation Standards](https://make.wordpress.org/core/handbook/inline-documentation-standards/php-documentation-standards/)
 * [Unclaimed files list](https://make.wordpress.org/docs/projects/inline-docs/unclaimed-hook-docs-files/)
 * [Hook Docs Triage list](https://make.wordpress.org/docs/projects/inline-docs/hook-docs-triage/)

[Top ↑](https://make.wordpress.org/docs/inline-docs/?output_format=md#top)

### 󠀁[Trac Reports](https://make.wordpress.org/docs/inline-docs/?output_format=md#trac-reports)󠁿

 * [Hook Docs tickets](https://core.trac.wordpress.org/query?status=accepted&status=assigned&status=new&status=reopened&status=reviewing&focuses=docs&summary=~Hook+Docs+(&order=priority)(
   claimed files)
 * [docs focus tickets](https://core.trac.wordpress.org/query?status=accepted&status=assigned&status=new&status=reopened&status=reviewing&focuses=docs&summary=!~Hook+Docs&summary=!~Hooks+Docs+(&col=id&col=summary&col=status&col=type&col=priority&col=milestone&col=component&order=priority)(
   tickets marked with Focus: docs)

[Top ↑](https://make.wordpress.org/docs/inline-docs/?output_format=md#top)

### 󠀁[Other Links](https://make.wordpress.org/docs/inline-docs/?output_format=md#other-links)󠁿

 * [Adam Brown’s Hooks Database](http://adambrown.info/p/wp_hooks) (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.)

 1. Pingback: [Kim Parsell, Affectionately Known as #wpmom Passes Away](http://wptavern.com/kim-parsell-affectionately-known-as-wpmom-passes-away)
 2. Pingback: [WPTavern: Kim Parsell, Affectionately Known as #wpmom Passes Away | Tech Pipeline](http://calpoint.com/techpipe/2015/01/05/wptavern-kim-parsell-affectionately-known-as-wpmom-passes-away/)

Comments are closed.

# Post navigation