Make WordPress Core


Ignore:
Timestamp:
10/02/2017 10:01:23 PM (7 years ago)
Author:
johnbillion
Message:

Docs: Remove & prefixes from parameter documentation to avoid doc parsing errors.

Props sudar for the original patch.

See #35974

File:
1 edited

Legend:

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

    r41162 r41686  
    10021002         * @since 1.5.0
    10031003         *
    1004          * @param WP_Query &$this The WP_Query instance (passed by reference).
     1004         * @param WP_Query $this The WP_Query instance (passed by reference).
    10051005         */
    10061006        do_action_ref_array( 'parse_query', array( &$this ) );
     
    16301630         * @since 2.0.0
    16311631         *
    1632          * @param WP_Query &$this The WP_Query instance (passed by reference).
     1632         * @param WP_Query $this The WP_Query instance (passed by reference).
    16331633         */
    16341634        do_action_ref_array( 'pre_get_posts', array( &$this ) );
     
    23722372             *
    23732373             * @param string   $where The WHERE clause of the query.
    2374              * @param WP_Query &$this The WP_Query instance (passed by reference).
     2374             * @param WP_Query $this The WP_Query instance (passed by reference).
    23752375             */
    23762376            $where = apply_filters_ref_array( 'posts_where', array( $where, &$this ) );
     
    23822382             *
    23832383             * @param string   $join  The JOIN clause of the query.
    2384              * @param WP_Query &$this The WP_Query instance (passed by reference).
     2384             * @param WP_Query $this The WP_Query instance (passed by reference).
    23852385             */
    23862386            $join = apply_filters_ref_array( 'posts_join', array( $join, &$this ) );
     
    24222422                 *
    24232423                 * @param string   $cjoin The JOIN clause of the query.
    2424                  * @param WP_Query &$this The WP_Query instance (passed by reference).
     2424                 * @param WP_Query $this The WP_Query instance (passed by reference).
    24252425                 */
    24262426                $cjoin = apply_filters_ref_array( 'comment_feed_join', array( $cjoin, &$this ) );
     
    24322432                 *
    24332433                 * @param string   $cwhere The WHERE clause of the query.
    2434                  * @param WP_Query &$this  The WP_Query instance (passed by reference).
     2434                 * @param WP_Query $this   The WP_Query instance (passed by reference).
    24352435                 */
    24362436                $cwhere = apply_filters_ref_array( 'comment_feed_where', array( $cwhere, &$this ) );
     
    24422442                 *
    24432443                 * @param string   $cgroupby The GROUP BY clause of the query.
    2444                  * @param WP_Query &$this    The WP_Query instance (passed by reference).
     2444                 * @param WP_Query $this     The WP_Query instance (passed by reference).
    24452445                 */
    24462446                $cgroupby = apply_filters_ref_array( 'comment_feed_groupby', array( $cgroupby, &$this ) );
     
    24522452                 *
    24532453                 * @param string   $corderby The ORDER BY clause of the query.
    2454                  * @param WP_Query &$this    The WP_Query instance (passed by reference).
     2454                 * @param WP_Query $this     The WP_Query instance (passed by reference).
    24552455                 */
    24562456                $corderby = apply_filters_ref_array( 'comment_feed_orderby', array( 'comment_date_gmt DESC', &$this ) );
     
    24622462                 *
    24632463                 * @param string   $climits The JOIN clause of the query.
    2464                  * @param WP_Query &$this   The WP_Query instance (passed by reference).
     2464                 * @param WP_Query $this    The WP_Query instance (passed by reference).
    24652465                 */
    24662466                $climits = apply_filters_ref_array( 'comment_feed_limits', array( 'LIMIT ' . get_option('posts_per_rss'), &$this ) );
     
    25032503             *
    25042504             * @param string   $where The WHERE clause of the query.
    2505              * @param WP_Query &$this The WP_Query instance (passed by reference).
     2505             * @param WP_Query $this The WP_Query instance (passed by reference).
    25062506             */
    25072507            $where = apply_filters_ref_array( 'posts_where_paged', array( $where, &$this ) );
     
    25132513             *
    25142514             * @param string   $groupby The GROUP BY clause of the query.
    2515              * @param WP_Query &$this   The WP_Query instance (passed by reference).
     2515             * @param WP_Query $this    The WP_Query instance (passed by reference).
    25162516             */
    25172517            $groupby = apply_filters_ref_array( 'posts_groupby', array( $groupby, &$this ) );
     
    25252525             *
    25262526             * @param string   $join  The JOIN clause of the query.
    2527              * @param WP_Query &$this The WP_Query instance (passed by reference).
     2527             * @param WP_Query $this The WP_Query instance (passed by reference).
    25282528             */
    25292529            $join = apply_filters_ref_array( 'posts_join_paged', array( $join, &$this ) );
     
    25352535             *
    25362536             * @param string   $orderby The ORDER BY clause of the query.
    2537              * @param WP_Query &$this   The WP_Query instance (passed by reference).
     2537             * @param WP_Query $this    The WP_Query instance (passed by reference).
    25382538             */
    25392539            $orderby = apply_filters_ref_array( 'posts_orderby', array( $orderby, &$this ) );
     
    25452545             *
    25462546             * @param string   $distinct The DISTINCT clause of the query.
    2547              * @param WP_Query &$this    The WP_Query instance (passed by reference).
     2547             * @param WP_Query $this     The WP_Query instance (passed by reference).
    25482548             */
    25492549            $distinct = apply_filters_ref_array( 'posts_distinct', array( $distinct, &$this ) );
     
    25552555             *
    25562556             * @param string   $limits The LIMIT clause of the query.
    2557              * @param WP_Query &$this  The WP_Query instance (passed by reference).
     2557             * @param WP_Query $this   The WP_Query instance (passed by reference).
    25582558             */
    25592559            $limits = apply_filters_ref_array( 'post_limits', array( $limits, &$this ) );
     
    25652565             *
    25662566             * @param string   $fields The SELECT clause of the query.
    2567              * @param WP_Query &$this  The WP_Query instance (passed by reference).
     2567             * @param WP_Query $this   The WP_Query instance (passed by reference).
    25682568             */
    25692569            $fields = apply_filters_ref_array( 'posts_fields', array( $fields, &$this ) );
     
    25782578             *
    25792579             * @param array    $clauses The list of clauses for the query.
    2580              * @param WP_Query &$this   The WP_Query instance (passed by reference).
     2580             * @param WP_Query $this    The WP_Query instance (passed by reference).
    25812581             */
    25822582            $clauses = (array) apply_filters_ref_array( 'posts_clauses', array( compact( $pieces ), &$this ) );
     
    26152615             *
    26162616             * @param string   $where The WHERE clause of the query.
    2617              * @param WP_Query &$this The WP_Query instance (passed by reference).
     2617             * @param WP_Query $this The WP_Query instance (passed by reference).
    26182618             */
    26192619            $where = apply_filters_ref_array( 'posts_where_request', array( $where, &$this ) );
     
    26272627             *
    26282628             * @param string   $groupby The GROUP BY clause of the query.
    2629              * @param WP_Query &$this   The WP_Query instance (passed by reference).
     2629             * @param WP_Query $this    The WP_Query instance (passed by reference).
    26302630             */
    26312631            $groupby = apply_filters_ref_array( 'posts_groupby_request', array( $groupby, &$this ) );
     
    26392639             *
    26402640             * @param string   $join  The JOIN clause of the query.
    2641              * @param WP_Query &$this The WP_Query instance (passed by reference).
     2641             * @param WP_Query $this The WP_Query instance (passed by reference).
    26422642             */
    26432643            $join = apply_filters_ref_array( 'posts_join_request', array( $join, &$this ) );
     
    26512651             *
    26522652             * @param string   $orderby The ORDER BY clause of the query.
    2653              * @param WP_Query &$this   The WP_Query instance (passed by reference).
     2653             * @param WP_Query $this    The WP_Query instance (passed by reference).
    26542654             */
    26552655            $orderby = apply_filters_ref_array( 'posts_orderby_request', array( $orderby, &$this ) );
     
    26632663             *
    26642664             * @param string   $distinct The DISTINCT clause of the query.
    2665              * @param WP_Query &$this    The WP_Query instance (passed by reference).
     2665             * @param WP_Query $this     The WP_Query instance (passed by reference).
    26662666             */
    26672667            $distinct = apply_filters_ref_array( 'posts_distinct_request', array( $distinct, &$this ) );
     
    26752675             *
    26762676             * @param string   $fields The SELECT clause of the query.
    2677              * @param WP_Query &$this  The WP_Query instance (passed by reference).
     2677             * @param WP_Query $this   The WP_Query instance (passed by reference).
    26782678             */
    26792679            $fields = apply_filters_ref_array( 'posts_fields_request', array( $fields, &$this ) );
     
    26872687             *
    26882688             * @param string   $limits The LIMIT clause of the query.
    2689              * @param WP_Query &$this  The WP_Query instance (passed by reference).
     2689             * @param WP_Query $this   The WP_Query instance (passed by reference).
    26902690             */
    26912691            $limits = apply_filters_ref_array( 'post_limits_request', array( $limits, &$this ) );
     
    27022702             *
    27032703             * @param array    $pieces The pieces of the query.
    2704              * @param WP_Query &$this  The WP_Query instance (passed by reference).
     2704             * @param WP_Query $this   The WP_Query instance (passed by reference).
    27052705             */
    27062706            $clauses = (array) apply_filters_ref_array( 'posts_clauses_request', array( compact( $pieces ), &$this ) );
     
    27332733             *
    27342734             * @param string   $request The complete SQL query.
    2735              * @param WP_Query &$this   The WP_Query instance (passed by reference).
     2735             * @param WP_Query $this    The WP_Query instance (passed by reference).
    27362736             */
    27372737            $this->request = apply_filters_ref_array( 'posts_request', array( $this->request, &$this ) );
     
    28462846             *
    28472847             * @param array    $posts The post results array.
    2848              * @param WP_Query &$this The WP_Query instance (passed by reference).
     2848             * @param WP_Query $this The WP_Query instance (passed by reference).
    28492849             */
    28502850            $this->posts = apply_filters_ref_array( 'posts_results', array( $this->posts, &$this ) );
     
    29182918                 *
    29192919                 * @param WP_Post  $post_preview  The Post object.
    2920                  * @param WP_Query &$this         The WP_Query instance (passed by reference).
     2920                 * @param WP_Query $this          The WP_Query instance (passed by reference).
    29212921                 */
    29222922                $this->posts[0] = get_post( apply_filters_ref_array( 'the_preview', array( $this->posts[0], &$this ) ) );
     
    29782978             *
    29792979             * @param array    $posts The array of retrieved posts.
    2980              * @param WP_Query &$this The WP_Query instance (passed by reference).
     2980             * @param WP_Query $this The WP_Query instance (passed by reference).
    29812981             */
    29822982            $this->posts = apply_filters_ref_array( 'the_posts', array( $this->posts, &$this ) );
     
    30293029             *
    30303030             * @param string   $found_posts The query to run to find the found posts.
    3031              * @param WP_Query &$this       The WP_Query instance (passed by reference).
     3031             * @param WP_Query $this        The WP_Query instance (passed by reference).
    30323032             */
    30333033            $this->found_posts = $wpdb->get_var( apply_filters_ref_array( 'found_posts_query', array( 'SELECT FOUND_ROWS()', &$this ) ) );
     
    30423042         *
    30433043         * @param int      $found_posts The number of posts found.
    3044          * @param WP_Query &$this       The WP_Query instance (passed by reference).
     3044         * @param WP_Query $this        The WP_Query instance (passed by reference).
    30453045         */
    30463046        $this->found_posts = apply_filters_ref_array( 'found_posts', array( $this->found_posts, &$this ) );
     
    30853085             * @since 2.0.0
    30863086             *
    3087              * @param WP_Query &$this The WP_Query instance (passed by reference).
     3087             * @param WP_Query $this The WP_Query instance (passed by reference).
    30883088             */
    30893089            do_action_ref_array( 'loop_start', array( &$this ) );
     
    31113111             * @since 2.0.0
    31123112             *
    3113              * @param WP_Query &$this The WP_Query instance (passed by reference).
     3113             * @param WP_Query $this The WP_Query instance (passed by reference).
    31143114             */
    31153115            do_action_ref_array( 'loop_end', array( &$this ) );
     
    40334033         * @since 4.1.0 Introduced `$this` parameter.
    40344034         *
    4035          * @param WP_Post  &$post The Post object (passed by reference).
    4036          * @param WP_Query &$this The current Query object (passed by reference).
     4035         * @param WP_Post  $post The Post object (passed by reference).
     4036         * @param WP_Query $this The current Query object (passed by reference).
    40374037         */
    40384038        do_action_ref_array( 'the_post', array( &$post, &$this ) );
Note: See TracChangeset for help on using the changeset viewer.