WordPress.org

Make WordPress Core

Opened 8 years ago

Closed 7 years ago

#25444 closed defect (bug) (fixed)

Hook Docs: wp-admin/customize.php

Reported by: DrewAPicture Owned by: kpdesign
Milestone: 3.7 Priority: normal
Severity: normal Version:
Component: Inline Docs Keywords: has-patch commit
Focuses: Cc:

Description

Patch forthcoming.

Attachments (7)

customize.diff (1.8 KB) - added by andg 8 years ago.
customize-v2.diff (1.8 KB) - added by andg 8 years ago.
Thanks, rzen, your version sounds definitely better!
25444.diff (1.6 KB) - added by DrewAPicture 7 years ago.
25444.1.diff (570 bytes) - added by kpdesign 7 years ago.
Add doc block for customize_allowed_urls
25444.2.diff (1.4 KB) - added by kpdesign 7 years ago.
Fix short descriptions
25444.3.diff (1.4 KB) - added by kpdesign 7 years ago.
Fix customize_allowed_urls short description (URLs, not URLS)
25444.4.diff (1.3 KB) - added by DrewAPicture 7 years ago.

Download all attachments as: .zip

Change History (23)

@andg
8 years ago

#1 @andg
8 years ago

Added inline documentation for the actions executed in this file.

#2 @andg
8 years ago

  • Keywords has-patch added; needs-patch removed

#3 @DrewAPicture
8 years ago

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

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.

#4 @rzen
8 years ago

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

@andg
8 years ago

Thanks, rzen, your version sounds definitely better!

#5 @andg
8 years ago

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

#6 @andg
8 years ago

  • Keywords has-patch added; needs-patch removed

#7 follow-up: @rzen
8 years ago

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

#8 in reply to: ↑ 7 @kpdesign
7 years ago

  • Keywords needs-patch added; has-patch removed

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
7 years ago

#9 @DrewAPicture
7 years ago

  • Keywords has-patch commit added; needs-patch removed
  • Milestone changed from Awaiting Review to 3.7

#10 @DrewAPicture
7 years ago

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

In 25826:

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

Props andg, rzen.
Fixes #25444.

@kpdesign
7 years ago

Add doc block for customize_allowed_urls

#11 @kpdesign
7 years ago

  • Resolution fixed deleted
  • Status changed from closed to reopened

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

#12 @nacin
7 years ago

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
7 years ago

Fix short descriptions

#13 @kpdesign
7 years ago

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

#14 @SergeyBiryukov
7 years ago

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

@kpdesign
7 years ago

Fix customize_allowed_urls short description (URLs, not URLS)

#15 @kpdesign
7 years ago

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

@DrewAPicture
7 years ago

#16 @DrewAPicture
7 years ago

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

In 25858:

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

Props kpdesign.
Fixes #25444.

Note: See TracTickets for help on using tickets.