WordPress.org

Make WordPress Core

Changeset 41686


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

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

Props sudar for the original patch.

See #35974

Location:
trunk/src
Files:
16 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/user.php

    r41376 r41686  
    135135     *
    136136     * @param string $user_login The username.
    137      * @param string &$pass1     The password, passed by reference.
    138      * @param string &$pass2     The confirmed password, passed by reference.
     137     * @param string $pass1     The password (passed by reference).
     138     * @param string $pass2     The confirmed password (passed by reference).
    139139     */
    140140    do_action_ref_array( 'check_passwords', array( $user->user_login, &$pass1, &$pass2 ) );
     
    185185     * @since 2.8.0
    186186     *
    187      * @param WP_Error &$errors WP_Error object, passed by reference.
     187     * @param WP_Error $errors WP_Error object (passed by reference).
    188188     * @param bool     $update  Whether this is a user update.
    189      * @param stdClass &$user   User object, passed by reference.
     189     * @param stdClass $user   User object (passed by reference).
    190190     */
    191191    do_action_ref_array( 'user_profile_update_errors', array( &$errors, $update, &$user ) );
  • trunk/src/wp-includes/Text/Diff/Engine/shell.php

    r13211 r41686  
    136136     * @access private
    137137     *
    138      * @param array &$text_lines Either $from_lines or $to_lines
    139      * @param int   &$line_no    Current line number
    140      * @param int   $end         Optional end line, when we want to chop more
    141      *                           than one line.
     138     * @param array $text_lines Either $from_lines or $to_lines (passed by reference).
     139     * @param int   $line_no    Current line number (passed by reference).
     140     * @param int   $end        Optional end line, when we want to chop more
     141     *                          than one line.
    142142     *
    143143     * @return array The chopped lines
  • trunk/src/wp-includes/class-wp-comment-query.php

    r41287 r41686  
    324324         * @since 4.2.0
    325325         *
    326          * @param WP_Comment_Query &$this The WP_Comment_Query instance (passed by reference).
     326         * @param WP_Comment_Query $this The WP_Comment_Query instance (passed by reference).
    327327         */
    328328        do_action_ref_array( 'parse_comment_query', array( &$this ) );
     
    370370         * @since 3.1.0
    371371         *
    372          * @param WP_Comment_Query &$this Current instance of WP_Comment_Query, passed by reference.
     372         * @param WP_Comment_Query $this Current instance of WP_Comment_Query (passed by reference).
    373373         */
    374374        do_action_ref_array( 'pre_get_comments', array( &$this ) );
     
    451451         *
    452452         * @param array            $_comments An array of comments.
    453          * @param WP_Comment_Query &$this     Current instance of WP_Comment_Query, passed by reference.
     453         * @param WP_Comment_Query $this     Current instance of WP_Comment_Query (passed by reference).
    454454         */
    455455        $_comments = apply_filters_ref_array( 'the_comments', array( $_comments, &$this ) );
     
    849849         *
    850850         * @param array            $pieces A compacted array of comment query clauses.
    851          * @param WP_Comment_Query &$this  Current instance of WP_Comment_Query, passed by reference.
     851         * @param WP_Comment_Query $this  Current instance of WP_Comment_Query (passed by reference).
    852852         */
    853853        $clauses = apply_filters_ref_array( 'comments_clauses', array( compact( $pieces ), &$this ) );
  • trunk/src/wp-includes/class-wp-http-curl.php

    r41162 r41686  
    208208         * @since 2.8.0
    209209         *
    210          * @param resource &$handle The cURL handle returned by curl_init().
     210         * @param resource $handle  The cURL handle returned by curl_init() (passed by reference).
    211211         * @param array    $r       The HTTP request arguments.
    212212         * @param string   $url     The request URL.
  • trunk/src/wp-includes/class-wp-network-query.php

    r41215 r41686  
    160160         * @since 4.6.0
    161161         *
    162          * @param WP_Network_Query &$this The WP_Network_Query instance (passed by reference).
     162         * @param WP_Network_Query $this The WP_Network_Query instance (passed by reference).
    163163         */
    164164        do_action_ref_array( 'parse_network_query', array( &$this ) );
     
    193193         * @since 4.6.0
    194194         *
    195          * @param WP_Network_Query &$this Current instance of WP_Network_Query, passed by reference.
     195         * @param WP_Network_Query $this Current instance of WP_Network_Query (passed by reference).
    196196         */
    197197        do_action_ref_array( 'pre_get_networks', array( &$this ) );
     
    260260         *
    261261         * @param array            $_networks An array of WP_Network objects.
    262          * @param WP_Network_Query &$this     Current instance of WP_Network_Query, passed by reference.
     262         * @param WP_Network_Query $this      Current instance of WP_Network_Query (passed by reference).
    263263         */
    264264        $_networks = apply_filters_ref_array( 'the_networks', array( $_networks, &$this ) );
     
    400400         *
    401401         * @param array            $pieces A compacted array of network query clauses.
    402          * @param WP_Network_Query &$this  Current instance of WP_Network_Query, passed by reference.
     402         * @param WP_Network_Query $this   Current instance of WP_Network_Query (passed by reference).
    403403         */
    404404        $clauses = apply_filters_ref_array( 'networks_clauses', array( compact( $pieces ), &$this ) );
  • 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 ) );
  • trunk/src/wp-includes/class-wp-site-query.php

    r41333 r41686  
    201201         * @since 4.6.0
    202202         *
    203          * @param WP_Site_Query &$this The WP_Site_Query instance (passed by reference).
     203         * @param WP_Site_Query $this The WP_Site_Query instance (passed by reference).
    204204         */
    205205        do_action_ref_array( 'parse_site_query', array( &$this ) );
     
    235235         * @since 4.6.0
    236236         *
    237          * @param WP_Site_Query &$this Current instance of WP_Site_Query, passed by reference.
     237         * @param WP_Site_Query $this Current instance of WP_Site_Query (passed by reference).
    238238         */
    239239        do_action_ref_array( 'pre_get_sites', array( &$this ) );
     
    304304         *
    305305         * @param array         $_sites An array of WP_Site objects.
    306          * @param WP_Site_Query &$this  Current instance of WP_Site_Query, passed by reference.
     306         * @param WP_Site_Query $this   Current instance of WP_Site_Query (passed by reference).
    307307         */
    308308        $_sites = apply_filters_ref_array( 'the_sites', array( $_sites, &$this ) );
     
    531531         * @since 4.6.0
    532532         *
    533          * @param array $pieces A compacted array of site query clauses.
    534          * @param WP_Site_Query &$this Current instance of WP_Site_Query, passed by reference.
     533         * @param array         $pieces A compacted array of site query clauses.
     534         * @param WP_Site_Query $this   Current instance of WP_Site_Query (passed by reference).
    535535         */
    536536        $clauses = apply_filters_ref_array( 'sites_clauses', array( compact( $pieces ), &$this ) );
  • trunk/src/wp-includes/class-wp.php

    r41162 r41686  
    369369         * @since 2.1.0
    370370         *
    371          * @param WP &$this Current WordPress environment instance (passed by reference).
     371         * @param WP $this Current WordPress environment instance (passed by reference).
    372372         */
    373373        do_action_ref_array( 'parse_request', array( &$this ) );
     
    500500         * @since 2.1.0
    501501         *
    502          * @param WP &$this Current WordPress environment instance (passed by reference).
     502         * @param WP $this Current WordPress environment instance (passed by reference).
    503503         */
    504504        do_action_ref_array( 'send_headers', array( &$this ) );
     
    722722         * @since 2.1.0
    723723         *
    724          * @param WP &$this Current WordPress environment instance (passed by reference).
     724         * @param WP $this Current WordPress environment instance (passed by reference).
    725725         */
    726726        do_action_ref_array( 'wp', array( &$this ) );
  • trunk/src/wp-includes/class.wp-scripts.php

    r41162 r41686  
    144144         * @since 2.6.0
    145145         *
    146          * @param WP_Scripts &$this WP_Scripts instance, passed by reference.
     146         * @param WP_Scripts $this WP_Scripts instance (passed by reference).
    147147         */
    148148        do_action_ref_array( 'wp_default_scripts', array(&$this) );
  • trunk/src/wp-includes/class.wp-styles.php

    r41162 r41686  
    112112         * @since 2.6.0
    113113         *
    114          * @param WP_Styles &$this WP_Styles instance, passed by reference.
     114         * @param WP_Styles $this WP_Styles instance (passed by reference).
    115115         */
    116116        do_action_ref_array( 'wp_default_styles', array(&$this) );
  • trunk/src/wp-includes/comment.php

    r40981 r41686  
    26012601     * @since 2.0.0
    26022602     *
    2603      * @param array &$post_links An array of post links to be checked, passed by reference.
    2604      * @param array &$pung       Whether a link has already been pinged, passed by reference.
    2605      * @param int   $post_ID     The post ID.
     2603     * @param array $post_links An array of post links to be checked (passed by reference).
     2604     * @param array $pung       Whether a link has already been pinged (passed by reference).
     2605     * @param int   $post_ID    The post ID.
    26062606     */
    26072607    do_action_ref_array( 'pre_ping', array( &$post_links, &$pung, $post->ID ) );
  • trunk/src/wp-includes/deprecated.php

    r41584 r41686  
    31563156 * @see get_post_ancestors()
    31573157 *
    3158  * @param WP_Post &$post Post object, passed by reference (unused).
     3158 * @param WP_Post $post Post object, passed by reference (unused).
    31593159 */
    31603160function _get_post_ancestors( &$post ) {
  • trunk/src/wp-includes/feed.php

    r39681 r41686  
    697697     * @since 3.0.0
    698698     *
    699      * @param object &$feed SimplePie feed object, passed by reference.
    700      * @param mixed  $url   URL of feed to retrieve. If an array of URLs, the feeds are merged.
     699     * @param object $feed SimplePie feed object (passed by reference).
     700     * @param mixed  $url  URL of feed to retrieve. If an array of URLs, the feeds are merged.
    701701     */
    702702    do_action_ref_array( 'wp_feed_options', array( &$feed, $url ) );
  • trunk/src/wp-includes/pluggable.php

    r41365 r41686  
    473473     * @since 2.2.0
    474474     *
    475      * @param PHPMailer &$phpmailer The PHPMailer instance, passed by reference.
     475     * @param PHPMailer $phpmailer The PHPMailer instance (passed by reference).
    476476     */
    477477    do_action_ref_array( 'phpmailer_init', array( &$phpmailer ) );
  • trunk/src/wp-includes/pomo/po.php

    r39592 r41686  
    202202     *
    203203     * @static
    204      * @param Translation_Entry &$entry the entry to convert to po string
     204     * @param Translation_Entry $entry the entry to convert to po string (passed by reference).
    205205     * @return false|string PO-style formatted string for the entry or
    206206     *  false if the entry is empty
  • trunk/src/wp-includes/pomo/translations.php

    r39051 r41686  
    1818     * Add entry to the PO structure
    1919     *
    20      * @param array|Translation_Entry &$entry
     20     * @param array|Translation_Entry $entry
    2121     * @return bool true on success, false if the entry doesn't have a key
    2222     */
     
    141141     * Merge $other in the current object.
    142142     *
    143      * @param Object &$other Another Translation object, whose translations will be merged in this one
     143     * @param Object $other Another Translation object, whose translations will be merged in this one (passed by reference).
    144144     * @return void
    145145     **/
Note: See TracChangeset for help on using the changeset viewer.