WordPress.org

Make WordPress Core

Changeset 37510


Ignore:
Timestamp:
05/22/2016 06:35:24 PM (3 years ago)
Author:
DrewAPicture
Message:

Docs: Standardize filter docs in wp-includes/functions.php to use third-person singular verbs per the inline documentation standards for PHP.

See #36913.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/functions.php

    r37444 r37510  
    146146
    147147    /**
    148      * Filter the date formatted based on the locale.
     148     * Filters the date formatted based on the locale.
    149149     *
    150150     * @since 2.8.0
     
    226226
    227227    /**
    228      * Filter the number formatted based on the locale.
     228     * Filters the number formatted based on the locale.
    229229     *
    230230     * @since  2.8.0
     
    584584
    585585    /**
    586      * Filter the list of enclosure links before querying the database.
     586     * Filters the list of enclosure links before querying the database.
    587587     *
    588588     * Allows for the addition and/or removal of potential enclosures to save
     
    882882
    883883    /**
    884      * Filter the list of query variables to remove.
     884     * Filters the list of query variables to remove.
    885885     *
    886886     * @since 4.2.0
     
    10701070
    10711071        /**
    1072          * Filter an HTTP status header.
     1072         * Filters an HTTP status header.
    10731073         *
    10741074         * @since 2.2.0
     
    11031103    if ( function_exists('apply_filters') ) {
    11041104        /**
    1105          * Filter the cache-controlling headers.
     1105         * Filters the cache-controlling headers.
    11061106         *
    11071107         * @since 2.8.0
     
    13241324
    13251325    /**
    1326      * Filter the robots.txt output.
     1326     * Filters the robots.txt output.
    13271327     *
    13281328     * @since 3.0.0
     
    18651865
    18661866    /**
    1867      * Filter the uploads directory data.
     1867     * Filters the uploads directory data.
    18681868     *
    18691869     * @since 2.0.0
     
    20572057
    20582058            /**
    2059              * Filter the result when generating a unique file name.
     2059             * Filters the result when generating a unique file name.
    20602060             *
    20612061             * @since 4.5.0
     
    21222122
    21232123    /**
    2124      * Filter whether to treat the upload bits as an error.
     2124     * Filters whether to treat the upload bits as an error.
    21252125     *
    21262126     * Passing a non-array to the filter will effectively short-circuit preparing
     
    22592259        if ( !empty($imgstats['mime']) && $imgstats['mime'] != $type ) {
    22602260            /**
    2261              * Filter the list mapping image mime types to their respective extensions.
     2261             * Filters the list mapping image mime types to their respective extensions.
    22622262             *
    22632263             * @since 3.0.0
     
    22922292
    22932293    /**
    2294      * Filter the "real" file type of the given file.
     2294     * Filters the "real" file type of the given file.
    22952295     *
    22962296     * @since 3.0.0
     
    23162316function wp_get_mime_types() {
    23172317    /**
    2318      * Filter the list of mime types and file extensions.
     2318     * Filters the list of mime types and file extensions.
    23192319     *
    23202320     * This filter should be used to add, not remove, mime types. To remove
     
    24392439
    24402440    /**
    2441      * Filter file type based on the extension name.
     2441     * Filters file type based on the extension name.
    24422442     *
    24432443     * @since 2.5.0
     
    24812481
    24822482    /**
    2483      * Filter list of allowed mime types and file extensions.
     2483     * Filters list of allowed mime types and file extensions.
    24842484     *
    24852485     * @since 2.0.0
     
    25612561    if ( defined( 'DOING_AJAX' ) && DOING_AJAX ) {
    25622562        /**
    2563          * Filter callback for killing WordPress execution for AJAX requests.
     2563         * Filters callback for killing WordPress execution for AJAX requests.
    25642564         *
    25652565         * @since 3.4.0
     
    25702570    } elseif ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST ) {
    25712571        /**
    2572          * Filter callback for killing WordPress execution for XML-RPC requests.
     2572         * Filters callback for killing WordPress execution for XML-RPC requests.
    25732573         *
    25742574         * @since 3.4.0
     
    25792579    } else {
    25802580        /**
    2581          * Filter callback for killing WordPress execution for all non-AJAX, non-XML-RPC requests.
     2581         * Filters callback for killing WordPress execution for all non-AJAX, non-XML-RPC requests.
    25822582         *
    25832583         * @since 3.0.0
     
    35143514function wp_maybe_load_widgets() {
    35153515    /**
    3516      * Filter whether to load the Widgets library.
     3516     * Filters whether to load the Widgets library.
    35173517     *
    35183518     * Passing a falsey value to the filter will effectively short-circuit
     
    36603660
    36613661    /**
    3662      * Filter whether to trigger an error for deprecated functions.
     3662     * Filters whether to trigger an error for deprecated functions.
    36633663     *
    36643664     * @since 2.5.0
     
    37163716
    37173717    /**
    3718      * Filter whether to trigger an error for deprecated functions.
     3718     * Filters whether to trigger an error for deprecated functions.
    37193719     *
    37203720     * `WP_DEBUG` must be true in addition to the filter evaluating to true.
     
    37833783
    37843784    /**
    3785      * Filter whether to trigger an error for deprecated files.
     3785     * Filters whether to trigger an error for deprecated files.
    37863786     *
    37873787     * @since 2.5.0
     
    38443844
    38453845    /**
    3846      * Filter whether to trigger an error for deprecated arguments.
     3846     * Filters whether to trigger an error for deprecated arguments.
    38473847     *
    38483848     * @since 3.0.0
     
    38953895
    38963896    /**
    3897      * Filter whether to trigger an error for _doing_it_wrong() calls.
     3897     * Filters whether to trigger an error for _doing_it_wrong() calls.
    38983898     *
    38993899     * @since 3.1.0
     
    39903990
    39913991    /**
    3992      * Filter whether IIS 7+ supports pretty permalinks.
     3992     * Filters whether IIS 7+ supports pretty permalinks.
    39933993     *
    39943994     * @since 2.8.0
     
    42474247
    42484248    /**
    4249      * Filter the main network ID.
     4249     * Filters the main network ID.
    42504250     *
    42514251     * @since 4.3.0
     
    42734273
    42744274        /**
    4275          * Filter whether global terms are enabled.
     4275         * Filters whether global terms are enabled.
    42764276         *
    42774277         * Passing a non-null value to the filter will effectively short-circuit the function,
     
    45914591
    45924592    /**
    4593      * Filter extra file headers by context.
     4593     * Filters extra file headers by context.
    45944594     *
    45954595     * The dynamic portion of the hook name, `$context`, refers to
     
    48404840
    48414841        /**
    4842          * Filter the list of protocols allowed in HTML attributes.
     4842         * Filters the list of protocols allowed in HTML attributes.
    48434843         *
    48444844         * @since 3.0.0
     
    49774977function wp_checkdate( $month, $day, $year, $source_date ) {
    49784978    /**
    4979      * Filter whether the given date is valid for the Gregorian calendar.
     4979     * Filters whether the given date is valid for the Gregorian calendar.
    49804980     *
    49814981     * @since 3.5.0
     
    50105010
    50115011    /**
    5012      * Filter whether to load the authentication check.
     5012     * Filters whether to load the authentication check.
    50135013     *
    50145014     * Passing a falsey value to the filter will effectively short-circuit
     
    50405040
    50415041    /**
    5042      * Filter whether the authentication check originated at the same domain.
     5042     * Filters whether the authentication check originated at the same domain.
    50435043     *
    50445044     * @since 3.6.0
     
    52275227function wp_delete_file( $file ) {
    52285228    /**
    5229      * Filter the path of the file to delete.
     5229     * Filters the path of the file to delete.
    52305230     *
    52315231     * @since 2.1.0
Note: See TracChangeset for help on using the changeset viewer.