WordPress.org

Make WordPress Core

Changeset 37491


Ignore:
Timestamp:
05/22/2016 06:09:59 PM (4 years ago)
Author:
DrewAPicture
Message:

Docs: Standardize filter docs in the Customizer classes to use third-person singular verbs per the inline documentation standards for PHP.

See #36913.

Location:
trunk/src/wp-includes
Files:
7 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/class-wp-customize-control.php

    r37342 r37491  
    236236
    237237        /**
    238          * Filter response of WP_Customize_Control::active().
     238         * Filters response of WP_Customize_Control::active().
    239239         *
    240240         * @since 4.0.0
  • trunk/src/wp-includes/class-wp-customize-manager.php

    r37476 r37491  
    243243
    244244        /**
    245          * Filter the core Customizer components to load.
     245         * Filters the core Customizer components to load.
    246246         *
    247247         * This allows Core components to be excluded from being instantiated by
     
    971971
    972972    /**
    973      * Filter the current theme and return the name of the previewed theme.
     973     * Filters the current theme and return the name of the previewed theme.
    974974     *
    975975     * @since 3.4.0
     
    10991099
    11001100        /**
    1101          * Filter response data for a successful customize_save AJAX request.
     1101         * Filters response data for a successful customize_save AJAX request.
    11021102         *
    11031103         * This filter does not apply if there was a nonce or authentication failure.
     
    11841184
    11851185            /**
    1186              * Filter a dynamic setting's constructor args.
     1186             * Filters a dynamic setting's constructor args.
    11871187             *
    11881188             * For a dynamic setting to be registered, this filter must be employed
     
    17411741
    17421742        /**
    1743          * Filter nonces for Customizer.
     1743         * Filters nonces for Customizer.
    17441744         *
    17451745         * @since 4.2.0
     
    17791779
    17801780        /**
    1781          * Filter the list of URLs allowed to be clicked and followed in the Customizer preview.
     1781         * Filters the list of URLs allowed to be clicked and followed in the Customizer preview.
    17821782         *
    17831783         * @since 3.4.0
     
    18991899
    19001900        /**
    1901          * Filter the available devices to allow previewing in the Customizer.
     1901         * Filters the available devices to allow previewing in the Customizer.
    19021902         *
    19031903         * @since 4.5.0
  • trunk/src/wp-includes/class-wp-customize-nav-menus.php

    r37040 r37491  
    212212
    213213        /**
    214          * Filter the available menu items.
     214         * Filters the available menu items.
    215215         *
    216216         * @since 4.3.0
     
    336336
    337337        /**
    338          * Filter the available menu items during a search request.
     338         * Filters the available menu items during a search request.
    339339         *
    340340         * @since 4.5.0
     
    429429
    430430    /**
    431      * Filter a dynamic setting's constructor args.
     431     * Filters a dynamic setting's constructor args.
    432432     *
    433433     * For a dynamic setting to be registered, this filter must be employed
     
    677677
    678678        /**
    679          * Filter the available menu item types.
     679         * Filters the available menu item types.
    680680         *
    681681         * @since 4.3.0
     
    832832
    833833    /**
    834      * Filter arguments for dynamic nav_menu selective refresh partials.
     834     * Filters arguments for dynamic nav_menu selective refresh partials.
    835835     *
    836836     * @since 4.5.0
  • trunk/src/wp-includes/class-wp-customize-panel.php

    r37342 r37491  
    180180
    181181        /**
    182          * Filter response of WP_Customize_Panel::active().
     182         * Filters response of WP_Customize_Panel::active().
    183183         *
    184184         * @since 4.1.0
  • trunk/src/wp-includes/class-wp-customize-section.php

    r37342 r37491  
    189189
    190190        /**
    191          * Filter response of WP_Customize_Section::active().
     191         * Filters response of WP_Customize_Section::active().
    192192         *
    193193         * @since 4.1.0
  • trunk/src/wp-includes/class-wp-customize-setting.php

    r37476 r37491  
    518518
    519519        /**
    520          * Filter a Customize setting value in un-slashed form.
     520         * Filters a Customize setting value in un-slashed form.
    521521         *
    522522         * @since 3.4.0
     
    694694
    695695            /**
    696              * Filter a Customize setting value not handled as a theme_mod or option.
     696             * Filters a Customize setting value not handled as a theme_mod or option.
    697697             *
    698698             * The dynamic portion of the hook name, `$this->id_date['base']`, refers to
     
    728728
    729729        /**
    730          * Filter a Customize setting value for use in JavaScript.
     730         * Filters a Customize setting value for use in JavaScript.
    731731         *
    732732         * The dynamic portion of the hook name, `$this->id`, refers to the setting ID.
  • trunk/src/wp-includes/class-wp-customize-widgets.php

    r37352 r37491  
    456456
    457457                    /**
    458                      * Filter Customizer widget section arguments for a given sidebar.
     458                     * Filters Customizer widget section arguments for a given sidebar.
    459459                     *
    460460                     * @since 3.9.0
     
    576576
    577577        /**
    578          * Filter whether the given widget is considered "wide".
     578         * Filters whether the given widget is considered "wide".
    579579         *
    580580         * @since 3.9.0
     
    840840
    841841        /**
    842          * Filter the common arguments supplied when constructing a Customizer setting.
     842         * Filters the common arguments supplied when constructing a Customizer setting.
    843843         *
    844844         * @since 3.9.0
Note: See TracChangeset for help on using the changeset viewer.