Hook Docs: wp-admin/customize.php

[DrewAPicture]

Patch forthcoming.

[andg]

Added inline documentation for the actions executed in this file.

[DrewAPicture]

Hi @andg, thanks for the patch. customize.diff​ looks pretty good, just a few things:

• All @since tags should use the 3-digit, x.x.x version style

customize_controls_enqueue_scripts hook:

• The short description reads a little awkwardly: "Fired when customizer scripts enqueuing occurs.". Maybe try rewording it.

[rzen]

I would suggest, "Fires during customizer control scripts enqueue."

[andg]

Thanks, rzen, your version sounds definitely better!

[andg]

Attached diff fine with a revised "customize_controls_enqueue_scripts" hook description.

[rzen]

@DrewAPicture this looks good to commit. For consistency, I'd recommend updating "Fired when..." to instead say "Fires when..."

[kpdesign]

Replying to rzen:

@DrewAPicture this looks good to commit. For consistency, I'd recommend updating "Fired when..." to instead say "Fires when..."

​Suggested language of the standard says "fires", so we should stay with that.

Actions: When does an action fire?
Good: Fires after most of core is loaded, and the user is authenticated.

Also, this patch still has issues that need to be fixed. I'm working on that this AM.

[DrewAPicture]

In 25826:

Inline documentation for hooks in wp-admin/customize.php.

Props andg, rzen.
Fixes #25444.

[kpdesign]

Add doc block for customize_allowed_urls

[kpdesign]

25444.1.diff​ adds doc block for customize_allowed_urls (missed in original patch).

[nacin]

25444.1.diff​ doesn't have enough context. Filter the allowed URLs for what? In this case, it is specifically for filtering the URLs that can be clicked inside the customizer preview and be followed, instead of being ignored.

Most of the hooks in [25826] are not "Fires when" but rather those hooks are used *for* enqueueing, or printing, or whatever.

[kpdesign]

Fix short descriptions

[kpdesign]

@nacin: Thanks for the review. :) 25444.2.diff​ incorporates your comments on the short descriptions.

[SergeyBiryukov]

"URLS" in line 176 should be "URLs".

[kpdesign]

Fix customize_allowed_urls short description (URLs, not URLS)

[kpdesign]

Thank you Sergey. :) Fixed in 25444.3.diff​.

[DrewAPicture]

In 25858:

Improve inline documentation for hooks in wp-admin/customize.php.

Props kpdesign.
Fixes #25444.