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

Props sudar for the original patch.

See #35974

Built from https://develop.svn.wordpress.org/trunk@41686


git-svn-id: http://core.svn.wordpress.org/trunk@41520 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
John Blackbourn
2017-10-02 22:03:33 +00:00
parent 253541556e
commit 9fdbe6538e
17 changed files with 73 additions and 73 deletions

View File

@@ -1001,7 +1001,7 @@ class WP_Query {
*
* @since 1.5.0
*
* @param WP_Query &$this The WP_Query instance (passed by reference).
* @param WP_Query $this The WP_Query instance (passed by reference).
*/
do_action_ref_array( 'parse_query', array( &$this ) );
}
@@ -1629,7 +1629,7 @@ class WP_Query {
*
* @since 2.0.0
*
* @param WP_Query &$this The WP_Query instance (passed by reference).
* @param WP_Query $this The WP_Query instance (passed by reference).
*/
do_action_ref_array( 'pre_get_posts', array( &$this ) );
@@ -2371,7 +2371,7 @@ class WP_Query {
* @since 1.5.0
*
* @param string $where The WHERE clause of the query.
* @param WP_Query &$this The WP_Query instance (passed by reference).
* @param WP_Query $this The WP_Query instance (passed by reference).
*/
$where = apply_filters_ref_array( 'posts_where', array( $where, &$this ) );
@@ -2381,7 +2381,7 @@ class WP_Query {
* @since 1.5.0
*
* @param string $join The JOIN clause of the query.
* @param WP_Query &$this The WP_Query instance (passed by reference).
* @param WP_Query $this The WP_Query instance (passed by reference).
*/
$join = apply_filters_ref_array( 'posts_join', array( $join, &$this ) );
}
@@ -2421,7 +2421,7 @@ class WP_Query {
* @since 2.2.0
*
* @param string $cjoin The JOIN clause of the query.
* @param WP_Query &$this The WP_Query instance (passed by reference).
* @param WP_Query $this The WP_Query instance (passed by reference).
*/
$cjoin = apply_filters_ref_array( 'comment_feed_join', array( $cjoin, &$this ) );
@@ -2431,7 +2431,7 @@ class WP_Query {
* @since 2.2.0
*
* @param string $cwhere The WHERE clause of the query.
* @param WP_Query &$this The WP_Query instance (passed by reference).
* @param WP_Query $this The WP_Query instance (passed by reference).
*/
$cwhere = apply_filters_ref_array( 'comment_feed_where', array( $cwhere, &$this ) );
@@ -2441,7 +2441,7 @@ class WP_Query {
* @since 2.2.0
*
* @param string $cgroupby The GROUP BY clause of the query.
* @param WP_Query &$this The WP_Query instance (passed by reference).
* @param WP_Query $this The WP_Query instance (passed by reference).
*/
$cgroupby = apply_filters_ref_array( 'comment_feed_groupby', array( $cgroupby, &$this ) );
@@ -2451,7 +2451,7 @@ class WP_Query {
* @since 2.8.0
*
* @param string $corderby The ORDER BY clause of the query.
* @param WP_Query &$this The WP_Query instance (passed by reference).
* @param WP_Query $this The WP_Query instance (passed by reference).
*/
$corderby = apply_filters_ref_array( 'comment_feed_orderby', array( 'comment_date_gmt DESC', &$this ) );
@@ -2461,7 +2461,7 @@ class WP_Query {
* @since 2.8.0
*
* @param string $climits The JOIN clause of the query.
* @param WP_Query &$this The WP_Query instance (passed by reference).
* @param WP_Query $this The WP_Query instance (passed by reference).
*/
$climits = apply_filters_ref_array( 'comment_feed_limits', array( 'LIMIT ' . get_option('posts_per_rss'), &$this ) );
}
@@ -2502,7 +2502,7 @@ class WP_Query {
* @since 1.5.0
*
* @param string $where The WHERE clause of the query.
* @param WP_Query &$this The WP_Query instance (passed by reference).
* @param WP_Query $this The WP_Query instance (passed by reference).
*/
$where = apply_filters_ref_array( 'posts_where_paged', array( $where, &$this ) );
@@ -2512,7 +2512,7 @@ class WP_Query {
* @since 2.0.0
*
* @param string $groupby The GROUP BY clause of the query.
* @param WP_Query &$this The WP_Query instance (passed by reference).
* @param WP_Query $this The WP_Query instance (passed by reference).
*/
$groupby = apply_filters_ref_array( 'posts_groupby', array( $groupby, &$this ) );
@@ -2524,7 +2524,7 @@ class WP_Query {
* @since 1.5.0
*
* @param string $join The JOIN clause of the query.
* @param WP_Query &$this The WP_Query instance (passed by reference).
* @param WP_Query $this The WP_Query instance (passed by reference).
*/
$join = apply_filters_ref_array( 'posts_join_paged', array( $join, &$this ) );
@@ -2534,7 +2534,7 @@ class WP_Query {
* @since 1.5.1
*
* @param string $orderby The ORDER BY clause of the query.
* @param WP_Query &$this The WP_Query instance (passed by reference).
* @param WP_Query $this The WP_Query instance (passed by reference).
*/
$orderby = apply_filters_ref_array( 'posts_orderby', array( $orderby, &$this ) );
@@ -2544,7 +2544,7 @@ class WP_Query {
* @since 2.1.0
*
* @param string $distinct The DISTINCT clause of the query.
* @param WP_Query &$this The WP_Query instance (passed by reference).
* @param WP_Query $this The WP_Query instance (passed by reference).
*/
$distinct = apply_filters_ref_array( 'posts_distinct', array( $distinct, &$this ) );
@@ -2554,7 +2554,7 @@ class WP_Query {
* @since 2.1.0
*
* @param string $limits The LIMIT clause of the query.
* @param WP_Query &$this The WP_Query instance (passed by reference).
* @param WP_Query $this The WP_Query instance (passed by reference).
*/
$limits = apply_filters_ref_array( 'post_limits', array( $limits, &$this ) );
@@ -2564,7 +2564,7 @@ class WP_Query {
* @since 2.1.0
*
* @param string $fields The SELECT clause of the query.
* @param WP_Query &$this The WP_Query instance (passed by reference).
* @param WP_Query $this The WP_Query instance (passed by reference).
*/
$fields = apply_filters_ref_array( 'posts_fields', array( $fields, &$this ) );
@@ -2577,7 +2577,7 @@ class WP_Query {
* @since 3.1.0
*
* @param array $clauses The list of clauses for the query.
* @param WP_Query &$this The WP_Query instance (passed by reference).
* @param WP_Query $this The WP_Query instance (passed by reference).
*/
$clauses = (array) apply_filters_ref_array( 'posts_clauses', array( compact( $pieces ), &$this ) );
@@ -2614,7 +2614,7 @@ class WP_Query {
* @since 2.5.0
*
* @param string $where The WHERE clause of the query.
* @param WP_Query &$this The WP_Query instance (passed by reference).
* @param WP_Query $this The WP_Query instance (passed by reference).
*/
$where = apply_filters_ref_array( 'posts_where_request', array( $where, &$this ) );
@@ -2626,7 +2626,7 @@ class WP_Query {
* @since 2.5.0
*
* @param string $groupby The GROUP BY clause of the query.
* @param WP_Query &$this The WP_Query instance (passed by reference).
* @param WP_Query $this The WP_Query instance (passed by reference).
*/
$groupby = apply_filters_ref_array( 'posts_groupby_request', array( $groupby, &$this ) );
@@ -2638,7 +2638,7 @@ class WP_Query {
* @since 2.5.0
*
* @param string $join The JOIN clause of the query.
* @param WP_Query &$this The WP_Query instance (passed by reference).
* @param WP_Query $this The WP_Query instance (passed by reference).
*/
$join = apply_filters_ref_array( 'posts_join_request', array( $join, &$this ) );
@@ -2650,7 +2650,7 @@ class WP_Query {
* @since 2.5.0
*
* @param string $orderby The ORDER BY clause of the query.
* @param WP_Query &$this The WP_Query instance (passed by reference).
* @param WP_Query $this The WP_Query instance (passed by reference).
*/
$orderby = apply_filters_ref_array( 'posts_orderby_request', array( $orderby, &$this ) );
@@ -2662,7 +2662,7 @@ class WP_Query {
* @since 2.5.0
*
* @param string $distinct The DISTINCT clause of the query.
* @param WP_Query &$this The WP_Query instance (passed by reference).
* @param WP_Query $this The WP_Query instance (passed by reference).
*/
$distinct = apply_filters_ref_array( 'posts_distinct_request', array( $distinct, &$this ) );
@@ -2674,7 +2674,7 @@ class WP_Query {
* @since 2.5.0
*
* @param string $fields The SELECT clause of the query.
* @param WP_Query &$this The WP_Query instance (passed by reference).
* @param WP_Query $this The WP_Query instance (passed by reference).
*/
$fields = apply_filters_ref_array( 'posts_fields_request', array( $fields, &$this ) );
@@ -2686,7 +2686,7 @@ class WP_Query {
* @since 2.5.0
*
* @param string $limits The LIMIT clause of the query.
* @param WP_Query &$this The WP_Query instance (passed by reference).
* @param WP_Query $this The WP_Query instance (passed by reference).
*/
$limits = apply_filters_ref_array( 'post_limits_request', array( $limits, &$this ) );
@@ -2701,7 +2701,7 @@ class WP_Query {
* @since 3.1.0
*
* @param array $pieces The pieces of the query.
* @param WP_Query &$this The WP_Query instance (passed by reference).
* @param WP_Query $this The WP_Query instance (passed by reference).
*/
$clauses = (array) apply_filters_ref_array( 'posts_clauses_request', array( compact( $pieces ), &$this ) );
@@ -2732,7 +2732,7 @@ class WP_Query {
* @since 2.0.0
*
* @param string $request The complete SQL query.
* @param WP_Query &$this The WP_Query instance (passed by reference).
* @param WP_Query $this The WP_Query instance (passed by reference).
*/
$this->request = apply_filters_ref_array( 'posts_request', array( $this->request, &$this ) );
}
@@ -2845,7 +2845,7 @@ class WP_Query {
* @since 2.3.0
*
* @param array $posts The post results array.
* @param WP_Query &$this The WP_Query instance (passed by reference).
* @param WP_Query $this The WP_Query instance (passed by reference).
*/
$this->posts = apply_filters_ref_array( 'posts_results', array( $this->posts, &$this ) );
}
@@ -2917,7 +2917,7 @@ class WP_Query {
* @since 2.7.0
*
* @param WP_Post $post_preview The Post object.
* @param WP_Query &$this The WP_Query instance (passed by reference).
* @param WP_Query $this The WP_Query instance (passed by reference).
*/
$this->posts[0] = get_post( apply_filters_ref_array( 'the_preview', array( $this->posts[0], &$this ) ) );
}
@@ -2977,7 +2977,7 @@ class WP_Query {
* @since 1.5.0
*
* @param array $posts The array of retrieved posts.
* @param WP_Query &$this The WP_Query instance (passed by reference).
* @param WP_Query $this The WP_Query instance (passed by reference).
*/
$this->posts = apply_filters_ref_array( 'the_posts', array( $this->posts, &$this ) );
}
@@ -3028,7 +3028,7 @@ class WP_Query {
* @since 2.1.0
*
* @param string $found_posts The query to run to find the found posts.
* @param WP_Query &$this The WP_Query instance (passed by reference).
* @param WP_Query $this The WP_Query instance (passed by reference).
*/
$this->found_posts = $wpdb->get_var( apply_filters_ref_array( 'found_posts_query', array( 'SELECT FOUND_ROWS()', &$this ) ) );
} else {
@@ -3041,7 +3041,7 @@ class WP_Query {
* @since 2.1.0
*
* @param int $found_posts The number of posts found.
* @param WP_Query &$this The WP_Query instance (passed by reference).
* @param WP_Query $this The WP_Query instance (passed by reference).
*/
$this->found_posts = apply_filters_ref_array( 'found_posts', array( $this->found_posts, &$this ) );
@@ -3084,7 +3084,7 @@ class WP_Query {
*
* @since 2.0.0
*
* @param WP_Query &$this The WP_Query instance (passed by reference).
* @param WP_Query $this The WP_Query instance (passed by reference).
*/
do_action_ref_array( 'loop_start', array( &$this ) );
@@ -3110,7 +3110,7 @@ class WP_Query {
*
* @since 2.0.0
*
* @param WP_Query &$this The WP_Query instance (passed by reference).
* @param WP_Query $this The WP_Query instance (passed by reference).
*/
do_action_ref_array( 'loop_end', array( &$this ) );
// Do some cleaning up after the loop
@@ -4032,8 +4032,8 @@ class WP_Query {
* @since 2.8.0
* @since 4.1.0 Introduced `$this` parameter.
*
* @param WP_Post &$post The Post object (passed by reference).
* @param WP_Query &$this The current Query object (passed by reference).
* @param WP_Post $post The Post object (passed by reference).
* @param WP_Query $this The current Query object (passed by reference).
*/
do_action_ref_array( 'the_post', array( &$post, &$this ) );