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

[leewillis77]

Patch in development

[leewillis77]

Hook docs patch

[kpdesign]

@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.

[leewillis77]

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

[DrewAPicture]

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

[kpdesign]

Minor tweaks

[kpdesign]

26196.3.diff​ contains a few minor tweaks.

Ready for a second review and a recommendation.

[DrewAPicture]

Final pass

[DrewAPicture]

In 26892:

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

Props leewillis77, kpdesign.
Fixes #26196.