#55499 closed enhancement (fixed)
$pagenow is used but not define in documentation of this function add_customize_screen_to_heartbeat_settings()
Reported by: |
|
Owned by: |
|
---|---|---|---|
Milestone: | 6.0 | Priority: | normal |
Severity: | normal | Version: | 4.9 |
Component: | Customize | Keywords: | has-patch needs-refresh |
Focuses: | docs | Cc: |
Description
global $pagenow is used add_customize_screen_to_heartbeat_settings($settings) in this function. But it is not mentioned in the documentation of the function.
Attachments (3)
Change History (9)
#1
@
3 years ago
- Type changed from defect (bug) to enhancement
Add doc comment for $global variable $pagenow. Find the latest attachment.
#2
@
3 years ago
- Keywords needs-refresh added
A search for string $pagenow
in the src
-directory gives that global
variables should be declared between the since
-tag and the param
-tags in the docblock.
Something like
* Filters heartbeat settings for the Customizer. * * @since 4.9.0 * * @global string $pagenow Description * * @param array $settings Current settings to filter.
#4
@
3 years ago
- Component changed from General to Customize
- Milestone changed from Awaiting Review to 6.0
Hi there, thanks for the patches!
I think we should add the missing @global
tag but may want to skip the description for now, as this global is also used in other methods of the same class, as well as many other areas of core, and should probably have a consistent description everywhere.
Note: See
TracTickets for help on using
tickets.
I have added patch of this ticket