Hook Docs (25): wp-includes/default-widgets.php

[janw.oostendorp]

Add hook documentation to wp-includes/default-widgets.php

[janw.oostendorp]

the documantation

[janw.oostendorp]

updated hooks

[janw.oostendorp]

New Diff replaced

//duplicate_hook

to :

/** This action|filter is documented in /wp-includes/default-widgets.php (this file) */

Since all duplicates are the widget_title hook, which is defined in the same file.

[dd32]

/** This action|filter is documented in /wp-includes/default-widgets.php (this file) */

FWIW, based on ​http://make.wordpress.org/core/handbook/inline-documentation-standards/php-documentation-standards/#4-1-duplicate-hooks

• you should also change action|filter to action or filter depending on if it's an apply_filters() / do_action() hook you're documenting
• file path shouldn't begin with /
• suffixing (this file) isn't needed, as it's primarily going to be used for automated parsing into the new documentation site when launched.

Based on ​http://make.wordpress.org/core/handbook/inline-documentation-standards/php-documentation-standards/#5-2-multi-line-comments you'll also want to wrap the descriptions in some of the longer blocks (such as for the widget_archives_dropdown_args filter)

Not intended to be a full review, just pointing out the few small things that I noticed.

[DrewAPicture]

See comment:4

[janw.oostendorp]

updated hooks

[janw.oostendorp]

updated hooks

[kpdesign]

Fourth pass

[kpdesign]

25638.4.diff​ contains formatting and language changes.

This needs a secondary review and a recommendation.

[DrewAPicture]

final pass

[DrewAPicture]

25638.3.diff​ should cover it.

[DrewAPicture]

In 27697:

Inline documentation for hooks in wp-includes/default-widgets.php.

Props janw.oostendorp and kpdesign.
Fixes #25638.