Make WordPress Core

Changeset 41688


Ignore:
Timestamp:
10/02/2017 10:13:04 PM (9 years ago)
Author:
johnbillion
Message:

Docs: Standardise the format used for documenting parameters passed by reference.

See #35974, #41017

Location:
trunk/src
Files:
21 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/class-walker-category-checklist.php

    r41221 r41688  
    2828         * @since 2.5.1
    2929         *
    30          * @param string $output Passed by reference. Used to append additional content.
     30         * @param string $output Used to append additional content (passed by reference).
    3131         * @param int    $depth  Depth of category. Used for tab indentation.
    3232         * @param array  $args   An array of arguments. @see wp_terms_checklist()
     
    4444         * @since 2.5.1
    4545         *
    46          * @param string $output Passed by reference. Used to append additional content.
     46         * @param string $output Used to append additional content (passed by reference).
    4747         * @param int    $depth  Depth of category. Used for tab indentation.
    4848         * @param array  $args   An array of arguments. @see wp_terms_checklist()
     
    6060         * @since 2.5.1
    6161         *
    62          * @param string $output   Passed by reference. Used to append additional content.
     62         * @param string $output   Used to append additional content (passed by reference).
    6363         * @param object $category The current term object.
    6464         * @param int    $depth    Depth of the term in reference to parents. Default 0.
     
    115115         * @since 2.5.1
    116116         *
    117          * @param string $output   Passed by reference. Used to append additional content.
     117         * @param string $output   Used to append additional content (passed by reference).
    118118         * @param object $category The current term object.
    119119         * @param int    $depth    Depth of the term in reference to parents. Default 0.
  • trunk/src/wp-admin/includes/class-walker-nav-menu-checklist.php

    r35202 r41688  
    3232         * @since 3.0.0
    3333         *
    34          * @param string $output Passed by reference. Used to append additional content.
     34         * @param string $output Used to append additional content (passed by reference).
    3535         * @param int    $depth  Depth of page. Used for padding.
    3636         * @param array  $args   Not used.
     
    4848         * @since 3.0.0
    4949         *
    50          * @param string $output Passed by reference. Used to append additional content.
     50         * @param string $output Used to append additional content (passed by reference).
    5151         * @param int    $depth  Depth of page. Used for padding.
    5252         * @param array  $args   Not used.
     
    6666         * @global int $_nav_menu_placeholder
    6767         *
    68          * @param string $output Passed by reference. Used to append additional content.
     68         * @param string $output Used to append additional content (passed by reference).
    6969         * @param object $item   Menu item data object.
    7070         * @param int    $depth  Depth of menu item. Used for padding.
  • trunk/src/wp-admin/includes/class-walker-nav-menu-edit.php

    r41227 r41688  
    5050         * @global int $_wp_nav_menu_max_depth
    5151         *
    52          * @param string $output Passed by reference. Used to append additional content.
     52         * @param string $output Used to append additional content (passed by reference).
    5353         * @param object $item   Menu item data object.
    5454         * @param int    $depth  Depth of menu item. Used for padding.
  • trunk/src/wp-admin/includes/credits.php

    r41605 r41688  
    5656 * @since 3.2.0
    5757 *
    58  * @param string $display_name  The contributor's display name, passed by reference.
     58 * @param string $display_name  The contributor's display name (passed by reference).
    5959 * @param string $username      The contributor's username.
    6060 * @param string $profiles      URL to the contributor's WordPress.org profile page.
     
    7070 * @since 3.2.0
    7171 *
    72  * @param string $data External library data, passed by reference.
     72 * @param string $data External library data (passed by reference).
    7373 */
    7474function _wp_credits_build_object_link( &$data ) {
  • trunk/src/wp-includes/cache.php

    r41162 r41688  
    113113 * @param bool        $force  Optional. Whether to force an update of the local cache from the persistent
    114114 *                            cache. Default false.
    115  * @param bool        $found  Optional. Whether the key was found in the cache. Disambiguates a return of false,
    116  *                            a storable value. Passed by reference. Default null.
     115 * @param bool        $found  Optional. Whether the key was found in the cache (passed by reference).
     116 *                            Disambiguates a return of false, a storable value. Default null.
    117117 * @return bool|mixed False on failure to retrieve contents or the cache
    118118 *                            contents on success
     
    517517         * @param string     $force  Optional. Unused. Whether to force a refetch rather than relying on the local
    518518         *                           cache. Default false.
    519          * @param bool       $found  Optional. Whether the key was found in the cache. Disambiguates a return of
    520          *                           false, a storable value. Passed by reference. Default null.
     519         * @param bool        $found  Optional. Whether the key was found in the cache (passed by reference).
     520         *                            Disambiguates a return of false, a storable value. Default null.
    521521         * @return false|mixed False on failure to retrieve contents or the cache contents on success.
    522522         */
  • trunk/src/wp-includes/class-walker-category-dropdown.php

    r41162 r41688  
    4545         * @see Walker::start_el()
    4646         *
    47          * @param string $output   Passed by reference. Used to append additional content.
     47         * @param string $output   Used to append additional content (passed by reference).
    4848         * @param object $category Category data object.
    4949         * @param int    $depth    Depth of category. Used for padding.
  • trunk/src/wp-includes/class-walker-category.php

    r41162 r41688  
    8585         * @see Walker::start_el()
    8686         *
    87          * @param string $output   Passed by reference. Used to append additional content.
     87         * @param string $output   Used to append additional content (passed by reference).
    8888         * @param object $category Category data object.
    8989         * @param int    $depth    Optional. Depth of category in reference to parents. Default 0.
     
    214214         * @see Walker::end_el()
    215215         *
    216          * @param string $output Passed by reference. Used to append additional content.
     216         * @param string $output Used to append additional content (passed by reference).
    217217         * @param object $page   Not used.
    218218         * @param int    $depth  Optional. Depth of category. Not used.
  • trunk/src/wp-includes/class-walker-comment.php

    r41162 r41688  
    4646         * @global int $comment_depth
    4747         *
    48          * @param string $output Passed by reference. Used to append additional content.
     48         * @param string $output Used to append additional content (passed by reference).
    4949         * @param int    $depth  Optional. Depth of the current comment. Default 0.
    5050         * @param array  $args   Optional. Uses 'style' argument for type of HTML list. Default empty array.
     
    7474         * @global int $comment_depth
    7575         *
    76          * @param string $output Passed by reference. Used to append additional content.
     76         * @param string $output Used to append additional content (passed by reference).
    7777         * @param int    $depth  Optional. Depth of the current comment. Default 0.
    7878         * @param array  $args   Optional. Will only append content if style argument value is 'ol' or 'ul'.
  • trunk/src/wp-includes/class-walker-nav-menu.php

    r41162 r41688  
    4444         * @see Walker::start_lvl()
    4545         *
    46          * @param string   $output Passed by reference. Used to append additional content.
     46         * @param string   $output Used to append additional content (passed by reference).
    4747         * @param int      $depth  Depth of menu item. Used for padding.
    4848         * @param stdClass $args   An object of wp_nav_menu() arguments.
     
    8383         * @see Walker::end_lvl()
    8484         *
    85          * @param string   $output Passed by reference. Used to append additional content.
     85         * @param string   $output Used to append additional content (passed by reference).
    8686         * @param int      $depth  Depth of menu item. Used for padding.
    8787         * @param stdClass $args   An object of wp_nav_menu() arguments.
     
    107107         * @see Walker::start_el()
    108108         *
    109          * @param string   $output Passed by reference. Used to append additional content.
     109         * @param string   $output Used to append additional content (passed by reference).
    110110         * @param WP_Post  $item   Menu item data object.
    111111         * @param int      $depth  Depth of menu item. Used for padding.
     
    246246         * @see Walker::end_el()
    247247         *
    248          * @param string   $output Passed by reference. Used to append additional content.
     248         * @param string   $output Used to append additional content (passed by reference).
    249249         * @param WP_Post  $item   Page data object. Not used.
    250250         * @param int      $depth  Depth of page. Not Used.
  • trunk/src/wp-includes/class-walker-page.php

    r41162 r41688  
    4545         * @see Walker::start_lvl()
    4646         *
    47          * @param string $output Passed by reference. Used to append additional content.
     47         * @param string $output Used to append additional content (passed by reference).
    4848         * @param int    $depth  Optional. Depth of page. Used for padding. Default 0.
    4949         * @param array  $args   Optional. Arguments for outputting the next level.
     
    6969         * @see Walker::end_lvl()
    7070         *
    71          * @param string $output Passed by reference. Used to append additional content.
     71         * @param string $output Used to append additional content (passed by reference).
    7272         * @param int    $depth  Optional. Depth of page. Used for padding. Default 0.
    7373         * @param array  $args   Optional. Arguments for outputting the end of the current level.
  • trunk/src/wp-includes/class-wp-meta-query.php

    r41162 r41688  
    382382         * @since 4.1.0
    383383         *
    384          * @param array $query Query to parse, passed by reference.
     384         * @param array $query Query to parse (passed by reference).
    385385         * @param int   $depth Optional. Number of tree levels deep we currently are.
    386386         *                     Used to calculate indentation. Default 0.
     
    467467         * @global wpdb $wpdb WordPress database abstraction object.
    468468         *
    469          * @param array  $clause       Query clause, passed by reference.
     469         * @param array  $clause       Query clause (passed by reference).
    470470         * @param array  $parent_query Parent query array.
    471471         * @param string $clause_key   Optional. The array key used to name the clause in the original `$meta_query`
  • trunk/src/wp-includes/class-wp-query.php

    r41686 r41688  
    27522752                 * @param array|null $posts Return an array of post data to short-circuit WP's query,
    27532753                 *                          or null to allow WP to run its normal queries.
    2754                  * @param WP_Query   $this  The WP_Query instance, passed by reference.
     2754                 * @param WP_Query   $this  The WP_Query instance (passed by reference).
    27552755                 */
    27562756                $this->posts = apply_filters_ref_array( 'posts_pre_query', array( null, &$this ) );
  • trunk/src/wp-includes/class-wp-rewrite.php

    r41162 r41688  
    13931393                 * @since 1.5.0
    13941394                 *
    1395                  * @param WP_Rewrite $this Current WP_Rewrite instance, passed by reference.
     1395                 * @param WP_Rewrite $this Current WP_Rewrite instance (passed by reference).
    13961396                 */
    13971397                do_action_ref_array( 'generate_rewrite_rules', array( &$this ) );
  • trunk/src/wp-includes/class-wp-tax-query.php

    r41162 r41688  
    292292         * @since 4.1.0
    293293         *
    294          * @param array $query Query to parse, passed by reference.
     294         * @param array $query Query to parse (passed by reference).
    295295         * @param int   $depth Optional. Number of tree levels deep we currently are.
    296296         *                     Used to calculate indentation. Default 0.
     
    375375         * @global wpdb $wpdb The WordPress database abstraction object.
    376376         *
    377          * @param array $clause       Query clause, passed by reference.
     377         * @param array $clause       Query clause (passed by reference).
    378378         * @param array $parent_query Parent query array.
    379379         * @return array {
  • trunk/src/wp-includes/class-wp-theme.php

    r41607 r41688  
    14271427         * @static
    14281428         *
    1429          * @param array $themes Array of themes to sort, passed by reference.
     1429         * @param array $themes Array of themes to sort (passed by reference).
    14301430         */
    14311431        public static function sort_by_name( &$themes ) {
  • trunk/src/wp-includes/class-wp-walker.php

    r41162 r41688  
    5656         * @abstract
    5757         *
    58          * @param string $output Passed by reference. Used to append additional content.
     58         * @param string $output Used to append additional content (passed by reference).
    5959         * @param int    $depth  Depth of the item.
    6060         * @param array  $args   An array of additional arguments.
     
    7171         * @abstract
    7272         *
    73          * @param string $output Passed by reference. Used to append additional content.
     73         * @param string $output Used to append additional content (passed by reference).
    7474         * @param int    $depth  Depth of the item.
    7575         * @param array  $args   An array of additional arguments.
     
    8686         * @abstract
    8787         *
    88          * @param string $output            Passed by reference. Used to append additional content.
     88         * @param string $output            Used to append additional content (passed by reference).
    8989         * @param object $object            The data object.
    9090         * @param int    $depth             Depth of the item.
     
    102102         * @abstract
    103103         *
    104          * @param string $output Passed by reference. Used to append additional content.
     104         * @param string $output Used to append additional content (passed by reference).
    105105         * @param object $object The data object.
    106106         * @param int    $depth  Depth of the item.
     
    122122         *
    123123         * @param object $element           Data object.
    124          * @param array  $children_elements List of elements to continue traversing.
     124         * @param array  $children_elements List of elements to continue traversing (passed by reference).
    125125         * @param int    $max_depth         Max depth to traverse.
    126126         * @param int    $depth             Depth of current element.
    127127         * @param array  $args              An array of arguments.
    128          * @param string $output            Passed by reference. Used to append additional content.
     128         * @param string $output            Used to append additional content (passed by reference).
    129129         */
    130130        public function display_element( $element, &$children_elements, $max_depth, $depth, $args, &$output ) {
  • trunk/src/wp-includes/class-wp-widget.php

    r41162 r41688  
    519519                         * @since 2.8.0
    520520                         *
    521                          * @param WP_Widget $this     The widget instance, passed by reference.
     521                         * @param WP_Widget $this     The widget instance (passed by reference).
    522522                         * @param null      $return   Return null if new fields are added.
    523523                         * @param array     $instance An array of the widget's settings.
  • trunk/src/wp-includes/ms-functions.php

    r41668 r41688  
    21602160 * @since MU (3.0.0)
    21612161 *
    2162  * @param PHPMailer $phpmailer The PHPMailer instance, passed by reference.
     2162 * @param PHPMailer $phpmailer The PHPMailer instance (passed by reference).
    21632163 */
    21642164function fix_phpmailer_messageid( $phpmailer ) {
  • trunk/src/wp-includes/post.php

    r41651 r41688  
    44494449 * @since 2.0.0
    44504450 *
    4451  * @param array $pages   Posts array, passed by reference.
     4451 * @param array $pages   Posts array (passed by reference).
    44524452 * @param int   $page_id Optional. Parent page ID. Default 0.
    44534453 * @return array A list arranged by hierarchy. Children immediately follow their parents.
     
    44804480 *
    44814481 * @param int   $page_id   Page ID.
    4482  * @param array $children  Parent-children relations, passed by reference.
    4483  * @param array $result    Result, passed by reference.
     4482 * @param array $children  Parent-children relations (passed by reference).
     4483 * @param array $result    Result (passed by reference).
    44844484 */
    44854485function _page_traverse_name( $page_id, &$children, &$result ){
     
    57325732 * @since 1.5.1
    57335733 *
    5734  * @param array $posts Array of post objects, passed by reference.
     5734 * @param array $posts Array of post objects (passed by reference).
    57355735 */
    57365736function update_post_cache( &$posts ) {
  • trunk/src/wp-includes/taxonomy.php

    r41684 r41688  
    33253325 * @global wpdb $wpdb WordPress database abstraction object.
    33263326 *
    3327  * @param array  $terms    List of term objects, passed by reference.
     3327 * @param array  $terms    List of term objects (passed by reference).
    33283328 * @param string $taxonomy Term context.
    33293329 */
  • trunk/src/wp-includes/user.php

    r41654 r41688  
    5858         * @todo Decide whether to deprecate the wp_authenticate action.
    5959         *
    60          * @param string $user_login    Username, passed by reference.
    61          * @param string $user_password User password, passed by reference.
     60         * @param string $user_login    Username (passed by reference).
     61         * @param string $user_password User password (passed by reference).
    6262         */
    6363        do_action_ref_array( 'wp_authenticate', array( &$credentials['user_login'], &$credentials['user_password'] ) );
Note: See TracChangeset for help on using the changeset viewer.