[wp-trac] [WordPress Trac] #55499: $pagenow is used but not define in documentation of this function add_customize_screen_to_heartbeat_settings()

[WordPress Trac]

#55499: $pagenow is used but not define in documentation of this function
add_customize_screen_to_heartbeat_settings()
-------------------------------------+------------------------------
 Reporter:  jontyravi                |       Owner:  (none)
     Type:  enhancement              |      Status:  new
 Priority:  normal                   |   Milestone:  Awaiting Review
Component:  General                  |     Version:  5.8
 Severity:  normal                   |  Resolution:
 Keywords:  has-patch needs-refresh  |     Focuses:  docs
-------------------------------------+------------------------------
Changes (by kebbet):

 * keywords:  has-patch => has-patch needs-refresh


Comment:

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

-- 
Ticket URL: <https://core.trac.wordpress.org/ticket/55499#comment:2>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform