WordPress.org

Make WordPress Core

Opened 5 months ago

Closed 4 months ago

Last modified 7 weeks ago

#26196 closed defect (bug) (fixed)

Hook Docs (2): wp-includes/class-wp-customize-section.php

Reported by: leewillis77 Owned by: kpdesign
Milestone: 3.9 Priority: normal
Severity: normal Version:
Component: Appearance Keywords: has-patch
Focuses: docs Cc:

Description

Patch in development

Attachments (4)

26196.diff (2.7 KB) - added by leewillis77 5 months ago.
Hook docs patch
26196.2.diff (944 bytes) - added by leewillis77 5 months ago.
Updated to remove non-hook docs, and other changes suggested.
26196.3.diff (945 bytes) - added by kpdesign 4 months ago.
Minor tweaks
26196.4.diff (924 bytes) - added by DrewAPicture 4 months ago.
Final pass

Download all attachments as: .zip

Change History (13)

leewillis775 months ago

Hook docs patch

comment:1 leewillis775 months ago

  • Keywords has-patch added

comment:2 kpdesign5 months ago

  • Keywords needs-patch added; has-patch removed
  • Owner set to kpdesign
  • Status changed from new to reviewing

@leewillis77: Thanks for the patch. :)

Just a few things:

General:

  • Your patch contains functional doc and hook doc changes. We are only doing hook docs in these tickets. Please remove the functional doc changes from this patch, and submit those changes in a separate patch on a new ticket, with the subject "PHPDoc updates for wp-includes/class-wp-customize-section.php".

customize_render_section:

  • Change the short description to read: "Fires before rendering the supported Customizer sections."
  • Add a blank line between the @since and the @param line, per the example doc block in the documentation standard.

'customize_render_section_' . $this->id:

  • Change the short description to read: "Fires before rendering each supported Customizer section."
  • Add a long description, such as: "The dynamic portion of the hook name, $this->id, refers to the ID of the supported Customizer section to be rendered."
  • Remove the @param line. $this->id is part of the hook name.
  • Change the do_action line to: do_action( "customize_render_section_{$this->id}" );

Could you make the above changes, and submit a new patch please? :)

Note: Please don't overwrite the original patch when uploading a new one – it is preferred to have copies of all attachments submitted to preserve the history of the ticket.

leewillis775 months ago

Updated to remove non-hook docs, and other changes suggested.

comment:3 leewillis775 months ago

  • Keywords has-patch added; needs-patch removed

comment:4 DrewAPicture4 months ago

  • Summary changed from Hook docs: wp-includes/class-wp-customize-section.php to Hook Docs (2): wp-includes/class-wp-customize-section.php

26196.2.diff looks to be in order. We'll get this reviewed today and hopefully wrap it up.

kpdesign4 months ago

Minor tweaks

comment:5 kpdesign4 months ago

26196.3.diff contains a few minor tweaks.

Ready for a second review and a recommendation.

comment:6 DrewAPicture4 months ago

  • Milestone changed from Awaiting Review to 3.9

DrewAPicture4 months ago

Final pass

comment:7 DrewAPicture4 months ago

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

In 26892:

Inline documentation for hooks in wp-includes/class-wp-customize-section.php.

Props leewillis77, kpdesign.
Fixes #26196.

comment:8 DrewAPicture7 weeks ago

  • Focuses docs added

comment:9 DrewAPicture7 weeks ago

  • Component changed from Inline Docs to Appearance
Note: See TracTickets for help on using tickets.