WordPress.org

Make WordPress Core

Opened 6 years ago

Closed 5 years ago

#25638 closed defect (bug) (fixed)

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

Reported by: janw.oostendorp Owned by: DrewAPicture
Milestone: 3.9 Priority: normal
Severity: normal Version:
Component: Widgets Keywords: has-patch commit
Focuses: docs Cc:

Description

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

Attachments (6)

25638.diff (10.8 KB) - added by janw.oostendorp 6 years ago.
the documantation
25638.2.diff (12.1 KB) - added by janw.oostendorp 6 years ago.
updated hooks
25638v3.diff (12.0 KB) - added by janw.oostendorp 6 years ago.
updated hooks
25638v3.2.diff (12.0 KB) - added by janw.oostendorp 6 years ago.
updated hooks
25638.4.diff (13.2 KB) - added by kpdesign 5 years ago.
Fourth pass
25638.3.diff (13.8 KB) - added by DrewAPicture 5 years ago.
final pass

Download all attachments as: .zip

Change History (16)

@janw.oostendorp
6 years ago

the documantation

#1 @kpdesign
6 years ago

  • Keywords has-patch added

#2 @DrewAPicture
6 years ago

  • Owner set to kpdesign
  • Status changed from new to reviewing

@janw.oostendorp
6 years ago

updated hooks

#3 @janw.oostendorp
6 years ago

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.

#4 @dd32
6 years ago

/** 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.

#5 @DrewAPicture
6 years ago

  • Keywords needs-patch added; has-patch removed
  • Summary changed from Hooks Docs: wp-includes/default-widgets.php to Hook Docs (25): wp-includes/default-widgets.php

See comment:4

@janw.oostendorp
6 years ago

updated hooks

@janw.oostendorp
6 years ago

updated hooks

#6 @kpdesign
6 years ago

  • Keywords has-patch added; needs-patch removed

#7 @jeremyfelt
6 years ago

  • Component changed from Inline Docs to Widgets
  • Focuses docs added

@kpdesign
5 years ago

Fourth pass

#8 @kpdesign
5 years ago

  • Owner changed from kpdesign to DrewAPicture

25638.4.diff contains formatting and language changes.

This needs a secondary review and a recommendation.

@DrewAPicture
5 years ago

final pass

#9 @DrewAPicture
5 years ago

  • Keywords commit added
  • Milestone changed from Awaiting Review to 3.9

25638.3.diff should cover it.

#10 @DrewAPicture
5 years ago

  • Resolution set to fixed
  • Status changed from reviewing to closed

In 27697:

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

Props janw.oostendorp and kpdesign.
Fixes #25638.

Note: See TracTickets for help on using tickets.