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

@ -134,8 +134,8 @@ function edit_user( $user_id = 0 ) {
* @since 1.5.1
*
* @param string $user_login The username.
* @param string &$pass1 The password, passed by reference.
* @param string &$pass2 The confirmed password, passed by reference.
* @param string $pass1 The password (passed by reference).
* @param string $pass2 The confirmed password (passed by reference).
*/
do_action_ref_array( 'check_passwords', array( $user->user_login, &$pass1, &$pass2 ) );
@ -184,9 +184,9 @@ function edit_user( $user_id = 0 ) {
*
* @since 2.8.0
*
* @param WP_Error &$errors WP_Error object, passed by reference.
* @param WP_Error $errors WP_Error object (passed by reference).
* @param bool $update Whether this is a user update.
* @param stdClass &$user User object, passed by reference.
* @param stdClass $user User object (passed by reference).
*/
do_action_ref_array( 'user_profile_update_errors', array( &$errors, $update, &$user ) );

View File

@ -135,10 +135,10 @@ class Text_Diff_Engine_shell {
*
* @access private
*
* @param array &$text_lines Either $from_lines or $to_lines
* @param int &$line_no Current line number
* @param int $end Optional end line, when we want to chop more
* than one line.
* @param array $text_lines Either $from_lines or $to_lines (passed by reference).
* @param int $line_no Current line number (passed by reference).
* @param int $end Optional end line, when we want to chop more
* than one line.
*
* @return array The chopped lines
*/

View File

@ -323,7 +323,7 @@ class WP_Comment_Query {
*
* @since 4.2.0
*
* @param WP_Comment_Query &$this The WP_Comment_Query instance (passed by reference).
* @param WP_Comment_Query $this The WP_Comment_Query instance (passed by reference).
*/
do_action_ref_array( 'parse_comment_query', array( &$this ) );
}
@ -369,7 +369,7 @@ class WP_Comment_Query {
*
* @since 3.1.0
*
* @param WP_Comment_Query &$this Current instance of WP_Comment_Query, passed by reference.
* @param WP_Comment_Query $this Current instance of WP_Comment_Query (passed by reference).
*/
do_action_ref_array( 'pre_get_comments', array( &$this ) );
@ -450,7 +450,7 @@ class WP_Comment_Query {
* @since 3.1.0
*
* @param array $_comments An array of comments.
* @param WP_Comment_Query &$this Current instance of WP_Comment_Query, passed by reference.
* @param WP_Comment_Query $this Current instance of WP_Comment_Query (passed by reference).
*/
$_comments = apply_filters_ref_array( 'the_comments', array( $_comments, &$this ) );
@ -848,7 +848,7 @@ class WP_Comment_Query {
* @since 3.1.0
*
* @param array $pieces A compacted array of comment query clauses.
* @param WP_Comment_Query &$this Current instance of WP_Comment_Query, passed by reference.
* @param WP_Comment_Query $this Current instance of WP_Comment_Query (passed by reference).
*/
$clauses = apply_filters_ref_array( 'comments_clauses', array( compact( $pieces ), &$this ) );

View File

@ -207,7 +207,7 @@ class WP_Http_Curl {
*
* @since 2.8.0
*
* @param resource &$handle The cURL handle returned by curl_init().
* @param resource $handle The cURL handle returned by curl_init() (passed by reference).
* @param array $r The HTTP request arguments.
* @param string $url The request URL.
*/

View File

@ -159,7 +159,7 @@ class WP_Network_Query {
*
* @since 4.6.0
*
* @param WP_Network_Query &$this The WP_Network_Query instance (passed by reference).
* @param WP_Network_Query $this The WP_Network_Query instance (passed by reference).
*/
do_action_ref_array( 'parse_network_query', array( &$this ) );
}
@ -192,7 +192,7 @@ class WP_Network_Query {
*
* @since 4.6.0
*
* @param WP_Network_Query &$this Current instance of WP_Network_Query, passed by reference.
* @param WP_Network_Query $this Current instance of WP_Network_Query (passed by reference).
*/
do_action_ref_array( 'pre_get_networks', array( &$this ) );
@ -259,7 +259,7 @@ class WP_Network_Query {
* @since 4.6.0
*
* @param array $_networks An array of WP_Network objects.
* @param WP_Network_Query &$this Current instance of WP_Network_Query, passed by reference.
* @param WP_Network_Query $this Current instance of WP_Network_Query (passed by reference).
*/
$_networks = apply_filters_ref_array( 'the_networks', array( $_networks, &$this ) );
@ -399,7 +399,7 @@ class WP_Network_Query {
* @since 4.6.0
*
* @param array $pieces A compacted array of network query clauses.
* @param WP_Network_Query &$this Current instance of WP_Network_Query, passed by reference.
* @param WP_Network_Query $this Current instance of WP_Network_Query (passed by reference).
*/
$clauses = apply_filters_ref_array( 'networks_clauses', array( compact( $pieces ), &$this ) );

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 ) );

View File

@ -200,7 +200,7 @@ class WP_Site_Query {
*
* @since 4.6.0
*
* @param WP_Site_Query &$this The WP_Site_Query instance (passed by reference).
* @param WP_Site_Query $this The WP_Site_Query instance (passed by reference).
*/
do_action_ref_array( 'parse_site_query', array( &$this ) );
}
@ -234,7 +234,7 @@ class WP_Site_Query {
*
* @since 4.6.0
*
* @param WP_Site_Query &$this Current instance of WP_Site_Query, passed by reference.
* @param WP_Site_Query $this Current instance of WP_Site_Query (passed by reference).
*/
do_action_ref_array( 'pre_get_sites', array( &$this ) );
@ -303,7 +303,7 @@ class WP_Site_Query {
* @since 4.6.0
*
* @param array $_sites An array of WP_Site objects.
* @param WP_Site_Query &$this Current instance of WP_Site_Query, passed by reference.
* @param WP_Site_Query $this Current instance of WP_Site_Query (passed by reference).
*/
$_sites = apply_filters_ref_array( 'the_sites', array( $_sites, &$this ) );
@ -530,8 +530,8 @@ class WP_Site_Query {
*
* @since 4.6.0
*
* @param array $pieces A compacted array of site query clauses.
* @param WP_Site_Query &$this Current instance of WP_Site_Query, passed by reference.
* @param array $pieces A compacted array of site query clauses.
* @param WP_Site_Query $this Current instance of WP_Site_Query (passed by reference).
*/
$clauses = apply_filters_ref_array( 'sites_clauses', array( compact( $pieces ), &$this ) );

View File

@ -368,7 +368,7 @@ class WP {
*
* @since 2.1.0
*
* @param WP &$this Current WordPress environment instance (passed by reference).
* @param WP $this Current WordPress environment instance (passed by reference).
*/
do_action_ref_array( 'parse_request', array( &$this ) );
}
@ -499,7 +499,7 @@ class WP {
*
* @since 2.1.0
*
* @param WP &$this Current WordPress environment instance (passed by reference).
* @param WP $this Current WordPress environment instance (passed by reference).
*/
do_action_ref_array( 'send_headers', array( &$this ) );
}
@ -721,7 +721,7 @@ class WP {
*
* @since 2.1.0
*
* @param WP &$this Current WordPress environment instance (passed by reference).
* @param WP $this Current WordPress environment instance (passed by reference).
*/
do_action_ref_array( 'wp', array( &$this ) );
}

View File

@ -143,7 +143,7 @@ class WP_Scripts extends WP_Dependencies {
*
* @since 2.6.0
*
* @param WP_Scripts &$this WP_Scripts instance, passed by reference.
* @param WP_Scripts $this WP_Scripts instance (passed by reference).
*/
do_action_ref_array( 'wp_default_scripts', array(&$this) );
}

View File

@ -111,7 +111,7 @@ class WP_Styles extends WP_Dependencies {
*
* @since 2.6.0
*
* @param WP_Styles &$this WP_Styles instance, passed by reference.
* @param WP_Styles $this WP_Styles instance (passed by reference).
*/
do_action_ref_array( 'wp_default_styles', array(&$this) );
}

View File

@ -2600,9 +2600,9 @@ function pingback( $content, $post_id ) {
*
* @since 2.0.0
*
* @param array &$post_links An array of post links to be checked, passed by reference.
* @param array &$pung Whether a link has already been pinged, passed by reference.
* @param int $post_ID The post ID.
* @param array $post_links An array of post links to be checked (passed by reference).
* @param array $pung Whether a link has already been pinged (passed by reference).
* @param int $post_ID The post ID.
*/
do_action_ref_array( 'pre_ping', array( &$post_links, &$pung, $post->ID ) );

View File

@ -3155,7 +3155,7 @@ function sticky_class( $post_id = null ) {
* @deprecated 3.5.0 Use get_post_ancestors()
* @see get_post_ancestors()
*
* @param WP_Post &$post Post object, passed by reference (unused).
* @param WP_Post $post Post object, passed by reference (unused).
*/
function _get_post_ancestors( &$post ) {
_deprecated_function( __FUNCTION__, '3.5.0' );

View File

@ -696,8 +696,8 @@ function fetch_feed( $url ) {
*
* @since 3.0.0
*
* @param object &$feed SimplePie feed object, passed by reference.
* @param mixed $url URL of feed to retrieve. If an array of URLs, the feeds are merged.
* @param object $feed SimplePie feed object (passed by reference).
* @param mixed $url URL of feed to retrieve. If an array of URLs, the feeds are merged.
*/
do_action_ref_array( 'wp_feed_options', array( &$feed, $url ) );
$feed->init();

View File

@ -472,7 +472,7 @@ function wp_mail( $to, $subject, $message, $headers = '', $attachments = array()
*
* @since 2.2.0
*
* @param PHPMailer &$phpmailer The PHPMailer instance, passed by reference.
* @param PHPMailer $phpmailer The PHPMailer instance (passed by reference).
*/
do_action_ref_array( 'phpmailer_init', array( &$phpmailer ) );

View File

@ -201,7 +201,7 @@ class PO extends Gettext_Translations {
* Builds a string from the entry for inclusion in PO file
*
* @static
* @param Translation_Entry &$entry the entry to convert to po string
* @param Translation_Entry $entry the entry to convert to po string (passed by reference).
* @return false|string PO-style formatted string for the entry or
* false if the entry is empty
*/

View File

@ -17,7 +17,7 @@ class Translations {
/**
* Add entry to the PO structure
*
* @param array|Translation_Entry &$entry
* @param array|Translation_Entry $entry
* @return bool true on success, false if the entry doesn't have a key
*/
function add_entry($entry) {
@ -140,7 +140,7 @@ class Translations {
/**
* Merge $other in the current object.
*
* @param Object &$other Another Translation object, whose translations will be merged in this one
* @param Object $other Another Translation object, whose translations will be merged in this one (passed by reference).
* @return void
**/
function merge_with(&$other) {

View File

@ -4,7 +4,7 @@
*
* @global string $wp_version
*/
$wp_version = '4.9-alpha-41685';
$wp_version = '4.9-alpha-41686';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.