Make WordPress Core


Ignore:
Timestamp:
10/17/2020 04:03:58 PM (4 years ago)
Author:
johnbillion
Message:

Docs: Fix and upgrade various object docblock notations.

See #50768

File:
1 edited

Legend:

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

    r49153 r49183  
    763763 * @param bool $all     Whether to retrieve all sites, or only sites that are not
    764764 *                      marked as deleted, archived, or spam.
    765  * @return array A list of the user's sites. An empty array if the user doesn't exist
    766  *               or belongs to no sites.
     765 * @return object[] A list of the user's sites. An empty array if the user doesn't exist
     766 *                  or belongs to no sites.
    767767 */
    768768function get_blogs_of_user( $user_id, $all = false ) {
     
    784784     * @since 4.6.0
    785785     *
    786      * @param null|array $sites   An array of site objects of which the user is a member.
    787      * @param int        $user_id User ID.
    788      * @param bool       $all     Whether the returned array should contain all sites, including
    789      *                            those marked 'deleted', 'archived', or 'spam'. Default false.
     786     * @param null|object[] $sites   An array of site objects of which the user is a member.
     787     * @param int           $user_id User ID.
     788     * @param bool          $all     Whether the returned array should contain all sites, including
     789     *                               those marked 'deleted', 'archived', or 'spam'. Default false.
    790790     */
    791791    $sites = apply_filters( 'pre_get_blogs_of_user', null, $user_id, $all );
     
    876876     * @since MU (3.0.0)
    877877     *
    878      * @param array $sites   An array of site objects belonging to the user.
    879      * @param int   $user_id User ID.
    880      * @param bool  $all     Whether the returned sites array should contain all sites, including
    881      *                       those marked 'deleted', 'archived', or 'spam'. Default false.
     878     * @param object[] $sites   An array of site objects belonging to the user.
     879     * @param int      $user_id User ID.
     880     * @param bool     $all     Whether the returned sites array should contain all sites, including
     881     *                          those marked 'deleted', 'archived', or 'spam'. Default false.
    882882     */
    883883    return apply_filters( 'get_blogs_of_user', $sites, $user_id, $all );
Note: See TracChangeset for help on using the changeset viewer.