From 5a96c219bf433003aa0c83947cd46b277b8032b0 Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Sun, 22 May 2016 18:09:59 +0000 Subject: [PATCH] Docs: Standardize filter docs in the Customizer classes to use third-person singular verbs per the inline documentation standards for PHP. See #36913. git-svn-id: https://develop.svn.wordpress.org/trunk@37491 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/class-wp-customize-control.php | 2 +- src/wp-includes/class-wp-customize-manager.php | 14 +++++++------- src/wp-includes/class-wp-customize-nav-menus.php | 10 +++++----- src/wp-includes/class-wp-customize-panel.php | 2 +- src/wp-includes/class-wp-customize-section.php | 2 +- src/wp-includes/class-wp-customize-setting.php | 6 +++--- src/wp-includes/class-wp-customize-widgets.php | 6 +++--- 7 files changed, 21 insertions(+), 21 deletions(-) diff --git a/src/wp-includes/class-wp-customize-control.php b/src/wp-includes/class-wp-customize-control.php index 400a0612ec..1920140ff0 100644 --- a/src/wp-includes/class-wp-customize-control.php +++ b/src/wp-includes/class-wp-customize-control.php @@ -235,7 +235,7 @@ class WP_Customize_Control { $active = call_user_func( $this->active_callback, $this ); /** - * Filter response of WP_Customize_Control::active(). + * Filters response of WP_Customize_Control::active(). * * @since 4.0.0 * diff --git a/src/wp-includes/class-wp-customize-manager.php b/src/wp-includes/class-wp-customize-manager.php index 911d2e94d1..d159458a78 100644 --- a/src/wp-includes/class-wp-customize-manager.php +++ b/src/wp-includes/class-wp-customize-manager.php @@ -242,7 +242,7 @@ final class WP_Customize_Manager { require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-setting.php' ); /** - * Filter the core Customizer components to load. + * Filters the core Customizer components to load. * * This allows Core components to be excluded from being instantiated by * filtering them out of the array. Note that this filter generally runs @@ -970,7 +970,7 @@ final class WP_Customize_Manager { } /** - * Filter the current theme and return the name of the previewed theme. + * Filters the current theme and return the name of the previewed theme. * * @since 3.4.0 * @@ -1098,7 +1098,7 @@ final class WP_Customize_Manager { do_action( 'customize_save_after', $this ); /** - * Filter response data for a successful customize_save AJAX request. + * Filters response data for a successful customize_save AJAX request. * * This filter does not apply if there was a nonce or authentication failure. * @@ -1183,7 +1183,7 @@ final class WP_Customize_Manager { $setting_class = 'WP_Customize_Setting'; /** - * Filter a dynamic setting's constructor args. + * Filters a dynamic setting's constructor args. * * For a dynamic setting to be registered, this filter must be employed * to override the default false value with an array of args to pass to @@ -1740,7 +1740,7 @@ final class WP_Customize_Manager { ); /** - * Filter nonces for Customizer. + * Filters nonces for Customizer. * * @since 4.2.0 * @@ -1778,7 +1778,7 @@ final class WP_Customize_Manager { } /** - * Filter the list of URLs allowed to be clicked and followed in the Customizer preview. + * Filters the list of URLs allowed to be clicked and followed in the Customizer preview. * * @since 3.4.0 * @@ -1898,7 +1898,7 @@ final class WP_Customize_Manager { ); /** - * Filter the available devices to allow previewing in the Customizer. + * Filters the available devices to allow previewing in the Customizer. * * @since 4.5.0 * diff --git a/src/wp-includes/class-wp-customize-nav-menus.php b/src/wp-includes/class-wp-customize-nav-menus.php index 778456727c..4bb112b320 100644 --- a/src/wp-includes/class-wp-customize-nav-menus.php +++ b/src/wp-includes/class-wp-customize-nav-menus.php @@ -211,7 +211,7 @@ final class WP_Customize_Nav_Menus { } /** - * Filter the available menu items. + * Filters the available menu items. * * @since 4.3.0 * @@ -335,7 +335,7 @@ final class WP_Customize_Nav_Menus { } /** - * Filter the available menu items during a search request. + * Filters the available menu items during a search request. * * @since 4.5.0 * @@ -428,7 +428,7 @@ final class WP_Customize_Nav_Menus { } /** - * Filter a dynamic setting's constructor args. + * Filters a dynamic setting's constructor args. * * For a dynamic setting to be registered, this filter must be employed * to override the default false value with an array of args to pass to @@ -676,7 +676,7 @@ final class WP_Customize_Nav_Menus { } /** - * Filter the available menu item types. + * Filters the available menu item types. * * @since 4.3.0 * @@ -831,7 +831,7 @@ final class WP_Customize_Nav_Menus { public $preview_nav_menu_instance_args = array(); /** - * Filter arguments for dynamic nav_menu selective refresh partials. + * Filters arguments for dynamic nav_menu selective refresh partials. * * @since 4.5.0 * @access public diff --git a/src/wp-includes/class-wp-customize-panel.php b/src/wp-includes/class-wp-customize-panel.php index d00beabace..46e604a9a6 100644 --- a/src/wp-includes/class-wp-customize-panel.php +++ b/src/wp-includes/class-wp-customize-panel.php @@ -179,7 +179,7 @@ class WP_Customize_Panel { $active = call_user_func( $this->active_callback, $this ); /** - * Filter response of WP_Customize_Panel::active(). + * Filters response of WP_Customize_Panel::active(). * * @since 4.1.0 * diff --git a/src/wp-includes/class-wp-customize-section.php b/src/wp-includes/class-wp-customize-section.php index 5228396d00..0a916f2f54 100644 --- a/src/wp-includes/class-wp-customize-section.php +++ b/src/wp-includes/class-wp-customize-section.php @@ -188,7 +188,7 @@ class WP_Customize_Section { $active = call_user_func( $this->active_callback, $this ); /** - * Filter response of WP_Customize_Section::active(). + * Filters response of WP_Customize_Section::active(). * * @since 4.1.0 * diff --git a/src/wp-includes/class-wp-customize-setting.php b/src/wp-includes/class-wp-customize-setting.php index a557b8f288..f5cb1bfcfc 100644 --- a/src/wp-includes/class-wp-customize-setting.php +++ b/src/wp-includes/class-wp-customize-setting.php @@ -517,7 +517,7 @@ class WP_Customize_Setting { public function sanitize( $value ) { /** - * Filter a Customize setting value in un-slashed form. + * Filters a Customize setting value in un-slashed form. * * @since 3.4.0 * @@ -693,7 +693,7 @@ class WP_Customize_Setting { $value = $this->get_root_value( $this->default ); /** - * Filter a Customize setting value not handled as a theme_mod or option. + * Filters a Customize setting value not handled as a theme_mod or option. * * The dynamic portion of the hook name, `$this->id_date['base']`, refers to * the base slug of the setting name. @@ -727,7 +727,7 @@ class WP_Customize_Setting { public function js_value() { /** - * Filter a Customize setting value for use in JavaScript. + * Filters a Customize setting value for use in JavaScript. * * The dynamic portion of the hook name, `$this->id`, refers to the setting ID. * diff --git a/src/wp-includes/class-wp-customize-widgets.php b/src/wp-includes/class-wp-customize-widgets.php index 52d174f362..b02ad945e9 100644 --- a/src/wp-includes/class-wp-customize-widgets.php +++ b/src/wp-includes/class-wp-customize-widgets.php @@ -455,7 +455,7 @@ final class WP_Customize_Widgets { ); /** - * Filter Customizer widget section arguments for a given sidebar. + * Filters Customizer widget section arguments for a given sidebar. * * @since 3.9.0 * @@ -575,7 +575,7 @@ final class WP_Customize_Widgets { $is_wide = ( $width > 250 && ! $is_core ); /** - * Filter whether the given widget is considered "wide". + * Filters whether the given widget is considered "wide". * * @since 3.9.0 * @@ -839,7 +839,7 @@ final class WP_Customize_Widgets { $args = array_merge( $args, $overrides ); /** - * Filter the common arguments supplied when constructing a Customizer setting. + * Filters the common arguments supplied when constructing a Customizer setting. * * @since 3.9.0 *