WordPress.org

Make WordPress Core

Changeset 39887


Ignore:
Timestamp:
01/12/17 05:20:57 (9 months ago)
Author:
SergeyBiryukov
Message:

Docs: Make $meta parameter description in multisite signup and registration functions more consistent.

See #38781.

File:
1 edited

Legend:

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

    r39886 r39887  
    766766 * @param string $user_email The user's email address. 
    767767 * @param string $key        The activation key created in wpmu_signup_blog() 
    768  * @param array  $meta       By default, contains the requested privacy setting and lang_id. 
     768 * @param array  $meta       Optional. Signup meta data. By default, contains the requested privacy setting and lang_id. 
    769769 * @return bool 
    770770 */ 
     
    781781     * @param string      $user_email User email address. 
    782782     * @param string      $key        Activation key created in wpmu_signup_blog(). 
    783      * @param array       $meta       By default, contains the requested privacy setting and lang_id. 
     783     * @param array       $meta       Signup meta data. By default, contains the requested privacy setting and lang_id. 
    784784     */ 
    785785    if ( ! apply_filters( 'wpmu_signup_blog_notification', $domain, $path, $title, $user_login, $user_email, $key, $meta ) ) { 
     
    818818         * @param string $user_email User email address. 
    819819         * @param string $key        Activation key created in wpmu_signup_blog(). 
    820          * @param array  $meta       By default, contains the requested privacy setting and lang_id. 
     820         * @param array  $meta       Signup meta data. By default, contains the requested privacy setting and lang_id. 
    821821         */ 
    822822        apply_filters( 'wpmu_signup_blog_notification_email', 
     
    842842         * @param string $user_email User email address. 
    843843         * @param string $key        Activation key created in wpmu_signup_blog(). 
    844          * @param array  $meta       By default, contains the requested privacy setting and lang_id. 
     844         * @param array  $meta       Signup meta data. By default, contains the requested privacy setting and lang_id. 
    845845         */ 
    846846        apply_filters( 'wpmu_signup_blog_notification_subject', 
     
    879879 * @param string $user_email The user's email address. 
    880880 * @param string $key        The activation key created in wpmu_signup_user() 
    881  * @param array  $meta       By default, an empty array. 
     881 * @param array  $meta       Optional. Signup meta data. Default empty array. 
    882882 * @return bool 
    883883 */ 
     
    891891     * @param string $user_email User email address. 
    892892     * @param string $key        Activation key created in wpmu_signup_user(). 
    893      * @param array  $meta       Signup meta data. 
     893     * @param array  $meta       Signup meta data. Default empty array. 
    894894     */ 
    895895    if ( ! apply_filters( 'wpmu_signup_user_notification', $user_login, $user_email, $key, $meta ) ) 
     
    917917         * @param string $user_email User email address. 
    918918         * @param string $key        Activation key created in wpmu_signup_user(). 
    919          * @param array  $meta       Signup meta data. 
     919         * @param array  $meta       Signup meta data. Default empty array. 
    920920         */ 
    921921        apply_filters( 'wpmu_signup_user_notification_email', 
     
    936936         * @param string $user_email User email address. 
    937937         * @param string $key        Activation key created in wpmu_signup_user(). 
    938          * @param array  $meta       Signup meta data. 
     938         * @param array  $meta       Signup meta data. Default empty array. 
    939939         */ 
    940940        apply_filters( 'wpmu_signup_user_notification_subject', 
     
    10421042     * @param int    $password      User password. 
    10431043     * @param string $signup_title  Site title. 
    1044      * @param array  $meta          Signup meta data. 
     1044     * @param array  $meta          Signup meta data. By default, contains the requested privacy setting and lang_id. 
    10451045     */ 
    10461046    do_action( 'wpmu_activate_blog', $blog_id, $user_id, $password, $signup->title, $meta ); 
     
    14421442 * @since MU 
    14431443 * 
    1444  * @param int    $blog_id 
    1445  * @param int    $user_id 
    1446  * @param string $password 
    1447  * @param string $title    The new blog's title 
    1448  * @param array  $meta     Optional. Not used in the default function, but is passed along to hooks for customization. 
     1444 * @param int    $blog_id  Blog ID. 
     1445 * @param int    $user_id  User ID. 
     1446 * @param string $password User password. 
     1447 * @param string $title    Site title. 
     1448 * @param array  $meta     Optional. Signup meta data. By default, contains the requested privacy setting and lang_id. 
    14491449 * @return bool 
    14501450 */ 
     
    14631463     * @param string   $password User password. 
    14641464     * @param string   $title    Site title. 
    1465      * @param array    $meta     Signup meta data. 
     1465     * @param array    $meta     Signup meta data. By default, contains the requested privacy setting and lang_id. 
    14661466     */ 
    14671467    if ( ! apply_filters( 'wpmu_welcome_notification', $blog_id, $user_id, $password, $title, $meta ) ) 
     
    15111511     * @param string $password      User password. 
    15121512     * @param string $title         Site title. 
    1513      * @param array  $meta          Signup meta data. 
     1513     * @param array  $meta          Signup meta data. By default, contains the requested privacy setting and lang_id. 
    15141514     */ 
    15151515    $welcome_email = apply_filters( 'update_welcome_email', $welcome_email, $blog_id, $user_id, $password, $title, $meta ); 
     
    15561556 * @since MU 
    15571557 * 
    1558  * @param int    $user_id 
    1559  * @param string $password 
    1560  * @param array  $meta     Optional. Not used in the default function, but is passed along to hooks for customization. 
     1558 * @param int    $user_id  User ID. 
     1559 * @param string $password User password. 
     1560 * @param array  $meta     Optional. Signup meta data. Default empty array. 
    15611561 * @return bool 
    15621562 */ 
     
    15731573     * @param int    $user_id  User ID. 
    15741574     * @param string $password User password. 
    1575      * @param array  $meta     Signup meta data. 
     1575     * @param array  $meta     Signup meta data. Default empty array. 
    15761576     */ 
    15771577    if ( ! apply_filters( 'wpmu_welcome_user_notification', $user_id, $password, $meta ) ) 
     
    15941594     * @param int    $user_id       User ID. 
    15951595     * @param string $password      User password. 
    1596      * @param array  $meta          Signup meta data. 
     1596     * @param array  $meta          Signup meta data. Default empty array. 
    15971597     */ 
    15981598    $welcome_email = apply_filters( 'update_welcome_user_email', $welcome_email, $user_id, $password, $meta ); 
Note: See TracChangeset for help on using the changeset viewer.