Make WordPress Core

Opened 13 years ago

Closed 11 years ago

Last modified 11 years ago

#16809 closed enhancement (fixed)

Inline Documentation Standard for Filters

Reported by: charlesclarkson's profile CharlesClarkson Owned by:
Milestone: 3.7 Priority: normal
Severity: normal Version: 3.1
Component: Inline Docs Keywords:
Focuses: Cc:


I was hoping to get some insight on how to document filters as they are applied in a function. I'm referring to the use of the apply_filter() function inside a WordPress function, not for the use of the add_filter() function.

I thought to use something like one of these, but wanted some input on whether either was complete enough.

 * @uses apply_filters() for 'wp_admin_bar_class' providing 'WP_Admin_Bar' as the default class.

 * @note Adds the 'wp_admin_bar_class' filter to allow changing the default 'WP_Admin_Bar' class.

 * @link

(Note: The link doesn't work yet. it is established from the Plugin API/Filter Reference)

I tend to look at inline docs as I use them (to update the codex and to research solutions) and that may not fit with other uses. I would rather not have to go back (too many times) because the my standard was useless to other users.


Change History (8)

#1 @hakre
13 years ago

Coding standrads have no spec on how to document them that far.

The current usage isn't normlized either.

I suggest to do as it suits you while monitoring this ticket for the time being.

Version 0, edited 13 years ago by hakre (next)

#2 @bananastalktome
12 years ago

  • Cc bananastalktome@… added

#3 @Rarst
12 years ago

  • Cc contact@… added

#4 @cais
12 years ago

  • Cc edward.caissie@… added

#5 @bueltge
12 years ago

  • Cc frank@… added

#6 @leewillis77
11 years ago

  • Cc junk@… added

#7 @DrewAPicture
11 years ago

  • Milestone changed from Awaiting Review to 3.7
  • Resolution set to fixed
  • Severity changed from trivial to normal
  • Status changed from new to closed

A full set of inline documentation standards were developed in concert with the inline-docs push starting in 3.7. They can be found in the Core Contributor Handbook, here:

Note: See TracTickets for help on using tickets.