From 5ac8c4158c089e7aef62d0a8553376a433c8eb9f Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Sun, 22 May 2016 18:35:54 +0000 Subject: [PATCH] Docs: Standardize filter docs in wp-includes/query.php to use third-person singular verbs per the inline documentation standards for PHP. See #36913. Built from https://develop.svn.wordpress.org/trunk@37509 git-svn-id: http://core.svn.wordpress.org/trunk@37477 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-includes/query.php | 74 ++++++++++++++++++++--------------------- wp-includes/version.php | 2 +- 2 files changed, 38 insertions(+), 38 deletions(-) diff --git a/wp-includes/query.php b/wp-includes/query.php index 876393797b..b609ce798a 100644 --- a/wp-includes/query.php +++ b/wp-includes/query.php @@ -2234,7 +2234,7 @@ class WP_Query { } /** - * Filter stopwords used when parsing search terms. + * Filters stopwords used when parsing search terms. * * @since 3.7.0 * @@ -2789,7 +2789,7 @@ class WP_Query { if ( ! $q['suppress_filters'] ) { /** - * Filter the search SQL that is used in the WHERE clause of WP_Query. + * Filters the search SQL that is used in the WHERE clause of WP_Query. * * @since 3.0.0 * @@ -3013,7 +3013,7 @@ class WP_Query { if ( ! $q['suppress_filters'] ) { /** - * Filter the ORDER BY used when ordering search results. + * Filters the ORDER BY used when ordering search results. * * @since 3.7.0 * @@ -3178,7 +3178,7 @@ class WP_Query { */ if ( !$q['suppress_filters'] ) { /** - * Filter the WHERE clause of the query. + * Filters the WHERE clause of the query. * * @since 1.5.0 * @@ -3188,7 +3188,7 @@ class WP_Query { $where = apply_filters_ref_array( 'posts_where', array( $where, &$this ) ); /** - * Filter the JOIN clause of the query. + * Filters the JOIN clause of the query. * * @since 1.5.0 * @@ -3228,7 +3228,7 @@ class WP_Query { if ( !$q['suppress_filters'] ) { /** - * Filter the JOIN clause of the comments feed query before sending. + * Filters the JOIN clause of the comments feed query before sending. * * @since 2.2.0 * @@ -3238,7 +3238,7 @@ class WP_Query { $cjoin = apply_filters_ref_array( 'comment_feed_join', array( $cjoin, &$this ) ); /** - * Filter the WHERE clause of the comments feed query before sending. + * Filters the WHERE clause of the comments feed query before sending. * * @since 2.2.0 * @@ -3248,7 +3248,7 @@ class WP_Query { $cwhere = apply_filters_ref_array( 'comment_feed_where', array( $cwhere, &$this ) ); /** - * Filter the GROUP BY clause of the comments feed query before sending. + * Filters the GROUP BY clause of the comments feed query before sending. * * @since 2.2.0 * @@ -3258,7 +3258,7 @@ class WP_Query { $cgroupby = apply_filters_ref_array( 'comment_feed_groupby', array( $cgroupby, &$this ) ); /** - * Filter the ORDER BY clause of the comments feed query before sending. + * Filters the ORDER BY clause of the comments feed query before sending. * * @since 2.8.0 * @@ -3268,7 +3268,7 @@ class WP_Query { $corderby = apply_filters_ref_array( 'comment_feed_orderby', array( 'comment_date_gmt DESC', &$this ) ); /** - * Filter the LIMIT clause of the comments feed query before sending. + * Filters the LIMIT clause of the comments feed query before sending. * * @since 2.8.0 * @@ -3306,7 +3306,7 @@ class WP_Query { */ if ( !$q['suppress_filters'] ) { /** - * Filter the WHERE clause of the query. + * Filters the WHERE clause of the query. * * Specifically for manipulating paging queries. * @@ -3318,7 +3318,7 @@ class WP_Query { $where = apply_filters_ref_array( 'posts_where_paged', array( $where, &$this ) ); /** - * Filter the GROUP BY clause of the query. + * Filters the GROUP BY clause of the query. * * @since 2.0.0 * @@ -3328,7 +3328,7 @@ class WP_Query { $groupby = apply_filters_ref_array( 'posts_groupby', array( $groupby, &$this ) ); /** - * Filter the JOIN clause of the query. + * Filters the JOIN clause of the query. * * Specifically for manipulating paging queries. * @@ -3340,7 +3340,7 @@ class WP_Query { $join = apply_filters_ref_array( 'posts_join_paged', array( $join, &$this ) ); /** - * Filter the ORDER BY clause of the query. + * Filters the ORDER BY clause of the query. * * @since 1.5.1 * @@ -3350,7 +3350,7 @@ class WP_Query { $orderby = apply_filters_ref_array( 'posts_orderby', array( $orderby, &$this ) ); /** - * Filter the DISTINCT clause of the query. + * Filters the DISTINCT clause of the query. * * @since 2.1.0 * @@ -3360,7 +3360,7 @@ class WP_Query { $distinct = apply_filters_ref_array( 'posts_distinct', array( $distinct, &$this ) ); /** - * Filter the LIMIT clause of the query. + * Filters the LIMIT clause of the query. * * @since 2.1.0 * @@ -3370,7 +3370,7 @@ class WP_Query { $limits = apply_filters_ref_array( 'post_limits', array( $limits, &$this ) ); /** - * Filter the SELECT clause of the query. + * Filters the SELECT clause of the query. * * @since 2.1.0 * @@ -3380,7 +3380,7 @@ class WP_Query { $fields = apply_filters_ref_array( 'posts_fields', array( $fields, &$this ) ); /** - * Filter all query clauses at once, for convenience. + * Filters all query clauses at once, for convenience. * * Covers the WHERE, GROUP BY, JOIN, ORDER BY, DISTINCT, * fields (SELECT), and LIMITS clauses. @@ -3413,12 +3413,12 @@ class WP_Query { do_action( 'posts_selection', $where . $groupby . $orderby . $limits . $join ); /* - * Filter again for the benefit of caching plugins. + * Filters again for the benefit of caching plugins. * Regular plugins should use the hooks above. */ if ( !$q['suppress_filters'] ) { /** - * Filter the WHERE clause of the query. + * Filters the WHERE clause of the query. * * For use by caching plugins. * @@ -3430,7 +3430,7 @@ class WP_Query { $where = apply_filters_ref_array( 'posts_where_request', array( $where, &$this ) ); /** - * Filter the GROUP BY clause of the query. + * Filters the GROUP BY clause of the query. * * For use by caching plugins. * @@ -3442,7 +3442,7 @@ class WP_Query { $groupby = apply_filters_ref_array( 'posts_groupby_request', array( $groupby, &$this ) ); /** - * Filter the JOIN clause of the query. + * Filters the JOIN clause of the query. * * For use by caching plugins. * @@ -3454,7 +3454,7 @@ class WP_Query { $join = apply_filters_ref_array( 'posts_join_request', array( $join, &$this ) ); /** - * Filter the ORDER BY clause of the query. + * Filters the ORDER BY clause of the query. * * For use by caching plugins. * @@ -3466,7 +3466,7 @@ class WP_Query { $orderby = apply_filters_ref_array( 'posts_orderby_request', array( $orderby, &$this ) ); /** - * Filter the DISTINCT clause of the query. + * Filters the DISTINCT clause of the query. * * For use by caching plugins. * @@ -3478,7 +3478,7 @@ class WP_Query { $distinct = apply_filters_ref_array( 'posts_distinct_request', array( $distinct, &$this ) ); /** - * Filter the SELECT clause of the query. + * Filters the SELECT clause of the query. * * For use by caching plugins. * @@ -3490,7 +3490,7 @@ class WP_Query { $fields = apply_filters_ref_array( 'posts_fields_request', array( $fields, &$this ) ); /** - * Filter the LIMIT clause of the query. + * Filters the LIMIT clause of the query. * * For use by caching plugins. * @@ -3502,7 +3502,7 @@ class WP_Query { $limits = apply_filters_ref_array( 'post_limits_request', array( $limits, &$this ) ); /** - * Filter all query clauses at once, for convenience. + * Filters all query clauses at once, for convenience. * * For use by caching plugins. * @@ -3538,7 +3538,7 @@ class WP_Query { if ( !$q['suppress_filters'] ) { /** - * Filter the completed SQL query before sending. + * Filters the completed SQL query before sending. * * @since 2.0.0 * @@ -3576,7 +3576,7 @@ class WP_Query { $split_the_query = ( $old_request == $this->request && "$wpdb->posts.*" == $fields && !empty( $limits ) && $q['posts_per_page'] < 500 ); /** - * Filter whether to split the query. + * Filters whether to split the query. * * Splitting the query will cause it to fetch just the IDs of the found posts * (and then individually fetch each post by ID), rather than fetching every @@ -3595,7 +3595,7 @@ class WP_Query { $this->request = "SELECT $found_rows $distinct $wpdb->posts.ID FROM $wpdb->posts $join WHERE 1=1 $where $groupby $orderby $limits"; /** - * Filter the Post IDs SQL request before sending. + * Filters the Post IDs SQL request before sending. * * @since 3.4.0 * @@ -3624,7 +3624,7 @@ class WP_Query { if ( ! $q['suppress_filters'] ) { /** - * Filter the raw post results array, prior to status checks. + * Filters the raw post results array, prior to status checks. * * @since 2.3.0 * @@ -3696,7 +3696,7 @@ class WP_Query { if ( $this->is_preview && $this->posts && current_user_can( $edit_cap, $this->posts[0]->ID ) ) { /** - * Filter the single post for preview mode. + * Filters the single post for preview mode. * * @since 2.7.0 * @@ -3755,7 +3755,7 @@ class WP_Query { if ( ! $q['suppress_filters'] ) { /** - * Filter the array of retrieved posts after they've been fetched and + * Filters the array of retrieved posts after they've been fetched and * internally processed. * * @since 1.5.0 @@ -3811,7 +3811,7 @@ class WP_Query { if ( ! empty( $limits ) ) { /** - * Filter the query to run for retrieving the found posts. + * Filters the query to run for retrieving the found posts. * * @since 2.1.0 * @@ -3824,7 +3824,7 @@ class WP_Query { } /** - * Filter the number of found posts for the query. + * Filters the number of found posts for the query. * * @since 2.1.0 * @@ -4797,7 +4797,7 @@ class WP_Query { } /** - * Filter the "pages" derived from splitting the post content. + * Filters the "pages" derived from splitting the post content. * * "Pages" are determined by splitting the post content based on the presence * of `` tags. @@ -4942,7 +4942,7 @@ function wp_old_slug_redirect() { } /** - * Filter the old slug redirect URL. + * Filters the old slug redirect URL. * * @since 4.4.0 * diff --git a/wp-includes/version.php b/wp-includes/version.php index 02e7c63290..87a8c67fe7 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -4,7 +4,7 @@ * * @global string $wp_version */ -$wp_version = '4.6-alpha-37508'; +$wp_version = '4.6-alpha-37509'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.