Make WordPress Core


Ignore:
Timestamp:
05/22/2016 06:34:42 PM (10 years ago)
Author:
DrewAPicture
Message:

Docs: Standardize filter docs in wp-includes/query.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/query.php

    r37487 r37509  
    22352235
    22362236                /**
    2237                  * Filter stopwords used when parsing search terms.
     2237                 * Filters stopwords used when parsing search terms.
    22382238                 *
    22392239                 * @since 3.7.0
     
    27902790                if ( ! $q['suppress_filters'] ) {
    27912791                        /**
    2792                          * Filter the search SQL that is used in the WHERE clause of WP_Query.
     2792                         * Filters the search SQL that is used in the WHERE clause of WP_Query.
    27932793                         *
    27942794                         * @since 3.0.0
     
    30143014                        if ( ! $q['suppress_filters'] ) {
    30153015                                /**
    3016                                  * Filter the ORDER BY used when ordering search results.
     3016                                 * Filters the ORDER BY used when ordering search results.
    30173017                                 *
    30183018                                 * @since 3.7.0
     
    31793179                if ( !$q['suppress_filters'] ) {
    31803180                        /**
    3181                          * Filter the WHERE clause of the query.
     3181                         * Filters the WHERE clause of the query.
    31823182                         *
    31833183                         * @since 1.5.0
     
    31893189
    31903190                        /**
    3191                          * Filter the JOIN clause of the query.
     3191                         * Filters the JOIN clause of the query.
    31923192                         *
    31933193                         * @since 1.5.0
     
    32293229                        if ( !$q['suppress_filters'] ) {
    32303230                                /**
    3231                                  * Filter the JOIN clause of the comments feed query before sending.
     3231                                 * Filters the JOIN clause of the comments feed query before sending.
    32323232                                 *
    32333233                                 * @since 2.2.0
     
    32393239
    32403240                                /**
    3241                                  * Filter the WHERE clause of the comments feed query before sending.
     3241                                 * Filters the WHERE clause of the comments feed query before sending.
    32423242                                 *
    32433243                                 * @since 2.2.0
     
    32493249
    32503250                                /**
    3251                                  * Filter the GROUP BY clause of the comments feed query before sending.
     3251                                 * Filters the GROUP BY clause of the comments feed query before sending.
    32523252                                 *
    32533253                                 * @since 2.2.0
     
    32593259
    32603260                                /**
    3261                                  * Filter the ORDER BY clause of the comments feed query before sending.
     3261                                 * Filters the ORDER BY clause of the comments feed query before sending.
    32623262                                 *
    32633263                                 * @since 2.8.0
     
    32693269
    32703270                                /**
    3271                                  * Filter the LIMIT clause of the comments feed query before sending.
     3271                                 * Filters the LIMIT clause of the comments feed query before sending.
    32723272                                 *
    32733273                                 * @since 2.8.0
     
    33073307                if ( !$q['suppress_filters'] ) {
    33083308                        /**
    3309                          * Filter the WHERE clause of the query.
     3309                         * Filters the WHERE clause of the query.
    33103310                         *
    33113311                         * Specifically for manipulating paging queries.
     
    33193319
    33203320                        /**
    3321                          * Filter the GROUP BY clause of the query.
     3321                         * Filters the GROUP BY clause of the query.
    33223322                         *
    33233323                         * @since 2.0.0
     
    33293329
    33303330                        /**
    3331                          * Filter the JOIN clause of the query.
     3331                         * Filters the JOIN clause of the query.
    33323332                         *
    33333333                         * Specifically for manipulating paging queries.
     
    33413341
    33423342                        /**
    3343                          * Filter the ORDER BY clause of the query.
     3343                         * Filters the ORDER BY clause of the query.
    33443344                         *
    33453345                         * @since 1.5.1
     
    33513351
    33523352                        /**
    3353                          * Filter the DISTINCT clause of the query.
     3353                         * Filters the DISTINCT clause of the query.
    33543354                         *
    33553355                         * @since 2.1.0
     
    33613361
    33623362                        /**
    3363                          * Filter the LIMIT clause of the query.
     3363                         * Filters the LIMIT clause of the query.
    33643364                         *
    33653365                         * @since 2.1.0
     
    33713371
    33723372                        /**
    3373                          * Filter the SELECT clause of the query.
     3373                         * Filters the SELECT clause of the query.
    33743374                         *
    33753375                         * @since 2.1.0
     
    33813381
    33823382                        /**
    3383                          * Filter all query clauses at once, for convenience.
     3383                         * Filters all query clauses at once, for convenience.
    33843384                         *
    33853385                         * Covers the WHERE, GROUP BY, JOIN, ORDER BY, DISTINCT,
     
    34143414
    34153415                /*
    3416                  * Filter again for the benefit of caching plugins.
     3416                 * Filters again for the benefit of caching plugins.
    34173417                 * Regular plugins should use the hooks above.
    34183418                 */
    34193419                if ( !$q['suppress_filters'] ) {
    34203420                        /**
    3421                          * Filter the WHERE clause of the query.
     3421                         * Filters the WHERE clause of the query.
    34223422                         *
    34233423                         * For use by caching plugins.
     
    34313431
    34323432                        /**
    3433                          * Filter the GROUP BY clause of the query.
     3433                         * Filters the GROUP BY clause of the query.
    34343434                         *
    34353435                         * For use by caching plugins.
     
    34433443
    34443444                        /**
    3445                          * Filter the JOIN clause of the query.
     3445                         * Filters the JOIN clause of the query.
    34463446                         *
    34473447                         * For use by caching plugins.
     
    34553455
    34563456                        /**
    3457                          * Filter the ORDER BY clause of the query.
     3457                         * Filters the ORDER BY clause of the query.
    34583458                         *
    34593459                         * For use by caching plugins.
     
    34673467
    34683468                        /**
    3469                          * Filter the DISTINCT clause of the query.
     3469                         * Filters the DISTINCT clause of the query.
    34703470                         *
    34713471                         * For use by caching plugins.
     
    34793479
    34803480                        /**
    3481                          * Filter the SELECT clause of the query.
     3481                         * Filters the SELECT clause of the query.
    34823482                         *
    34833483                         * For use by caching plugins.
     
    34913491
    34923492                        /**
    3493                          * Filter the LIMIT clause of the query.
     3493                         * Filters the LIMIT clause of the query.
    34943494                         *
    34953495                         * For use by caching plugins.
     
    35033503
    35043504                        /**
    3505                          * Filter all query clauses at once, for convenience.
     3505                         * Filters all query clauses at once, for convenience.
    35063506                         *
    35073507                         * For use by caching plugins.
     
    35393539                if ( !$q['suppress_filters'] ) {
    35403540                        /**
    3541                          * Filter the completed SQL query before sending.
     3541                         * Filters the completed SQL query before sending.
    35423542                         *
    35433543                         * @since 2.0.0
     
    35773577
    35783578                /**
    3579                  * Filter whether to split the query.
     3579                 * Filters whether to split the query.
    35803580                 *
    35813581                 * Splitting the query will cause it to fetch just the IDs of the found posts
     
    35963596
    35973597                        /**
    3598                          * Filter the Post IDs SQL request before sending.
     3598                         * Filters the Post IDs SQL request before sending.
    35993599                         *
    36003600                         * @since 3.4.0
     
    36253625                if ( ! $q['suppress_filters'] ) {
    36263626                        /**
    3627                          * Filter the raw post results array, prior to status checks.
     3627                         * Filters the raw post results array, prior to status checks.
    36283628                         *
    36293629                         * @since 2.3.0
     
    36973697                        if ( $this->is_preview && $this->posts && current_user_can( $edit_cap, $this->posts[0]->ID ) ) {
    36983698                                /**
    3699                                  * Filter the single post for preview mode.
     3699                                 * Filters the single post for preview mode.
    37003700                                 *
    37013701                                 * @since 2.7.0
     
    37563756                if ( ! $q['suppress_filters'] ) {
    37573757                        /**
    3758                          * Filter the array of retrieved posts after they've been fetched and
     3758                         * Filters the array of retrieved posts after they've been fetched and
    37593759                         * internally processed.
    37603760                         *
     
    38123812                if ( ! empty( $limits ) ) {
    38133813                        /**
    3814                          * Filter the query to run for retrieving the found posts.
     3814                         * Filters the query to run for retrieving the found posts.
    38153815                         *
    38163816                         * @since 2.1.0
     
    38253825
    38263826                /**
    3827                  * Filter the number of found posts for the query.
     3827                 * Filters the number of found posts for the query.
    38283828                 *
    38293829                 * @since 2.1.0
     
    47984798
    47994799                /**
    4800                  * Filter the "pages" derived from splitting the post content.
     4800                 * Filters the "pages" derived from splitting the post content.
    48014801                 *
    48024802                 * "Pages" are determined by splitting the post content based on the presence
     
    49434943
    49444944                /**
    4945                  * Filter the old slug redirect URL.
     4945                 * Filters the old slug redirect URL.
    49464946                 *
    49474947                 * @since 4.4.0
Note: See TracChangeset for help on using the changeset viewer.