Make WordPress Core

Changeset 49078


Ignore:
Timestamp:
09/30/2020 09:52:27 PM (4 years ago)
Author:
johnbillion
Message:

Docs: Various docblock improvements related to user and site signup functionality.

See #50768

Location:
trunk/src
Files:
4 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/ms-delete-site.php

    r48201 r49078  
    7373    );
    7474    /**
    75      * Filters the email content sent when a site in a Multisite network is deleted.
     75     * Filters the text for the email sent to the site admin when a request to delete a site in a Multisite network is submitted.
    7676     *
    7777     * @since 3.0.0
    7878     *
    79      * @param string $content The email content that will be sent to the user who deleted a site in a Multisite network.
     79     * @param string $content The email text.
    8080     */
    8181    $content = apply_filters( 'delete_site_email_content', $content );
  • trunk/src/wp-includes/ms-functions.php

    r49028 r49078  
    15761576
    15771577/**
    1578  * Notify a user that their blog activation has been successful.
     1578 * Notifies the site administrator that their site activation was successful.
    15791579 *
    15801580 * Filter {@see 'wpmu_welcome_notification'} to disable or bypass.
     
    15851585 * @since MU (3.0.0)
    15861586 *
    1587  * @param int    $blog_id  Blog ID.
     1587 * @param int    $blog_id  Site ID.
    15881588 * @param int    $user_id  User ID.
    1589  * @param string $password User password.
     1589 * @param string $password User password, or "N/A" if the user account is not new.
    15901590 * @param string $title    Site title.
    15911591 * @param array  $meta     Optional. Signup meta data. By default, contains the requested privacy setting and lang_id.
    1592  * @return bool
     1592 * @return bool Whether the email notification was sent.
    15931593 */
    15941594function wpmu_welcome_notification( $blog_id, $user_id, $password, $title, $meta = array() ) {
     
    15961596
    15971597    /**
    1598      * Filters whether to bypass the welcome email after site activation.
     1598     * Filters whether to bypass the welcome email sent to the site administrator after site activation.
    15991599     *
    16001600     * Returning false disables the welcome email.
     
    16021602     * @since MU (3.0.0)
    16031603     *
    1604      * @param int|bool $blog_id  Blog ID.
    1605      * @param int      $user_id  User ID.
    1606      * @param string   $password User password.
     1604     * @param int|bool $blog_id  Site ID.
     1605     * @param int      $user_id  User ID of the site administrator.
     1606     * @param string   $password User password, or "N/A" if the user account is not new.
    16071607     * @param string   $title    Site title.
    16081608     * @param array    $meta     Signup meta data. By default, contains the requested privacy setting and lang_id.
     
    16461646
    16471647    /**
    1648      * Filters the content of the welcome email after site activation.
     1648     * Filters the content of the welcome email sent to the site administrator after site activation.
    16491649     *
    16501650     * Content should be formatted for transmission via wp_mail().
     
    16531653     *
    16541654     * @param string $welcome_email Message body of the email.
    1655      * @param int    $blog_id       Blog ID.
    1656      * @param int    $user_id       User ID.
    1657      * @param string $password      User password.
     1655     * @param int    $blog_id       Site ID.
     1656     * @param int    $user_id       User ID of the site administrator.
     1657     * @param string $password      User password, or "N/A" if the user account is not new.
    16581658     * @param string $title         Site title.
    16591659     * @param array  $meta          Signup meta data. By default, contains the requested privacy setting and lang_id.
     
    16791679
    16801680    /**
    1681      * Filters the subject of the welcome email after site activation.
     1681     * Filters the subject of the welcome email sent to the site administrator after site activation.
    16821682     *
    16831683     * @since MU (3.0.0)
  • trunk/src/wp-login.php

    r48359 r49078  
    324324
    325325/**
    326  * Outputs the Javascript to handle the form shaking.
     326 * Outputs the Javascript to handle the form shaking on the login page.
    327327 *
    328328 * @since 3.0.0
     
    337337
    338338/**
    339  * Outputs the viewport meta tag.
     339 * Outputs the viewport meta tag for the login page.
    340340 *
    341341 * @since 3.7.0
     
    348348
    349349/**
    350  * Handles sending password retrieval email to user.
     350 * Handles sending a password retrieval email to a user.
    351351 *
    352352 * @since 2.5.0
    353353 *
    354  * @return bool|WP_Error True: when finish. WP_Error on error
     354 * @return true|WP_Error True when finished, WP_Error object on error.
    355355 */
    356356function retrieve_password() {
     
    423423        /*
    424424         * The blogname option is escaped with esc_html on the way into the database
    425          * in sanitize_option we want to reverse this for the plain text arena of emails.
     425         * in sanitize_option. We want to reverse this for the plain text arena of emails.
    426426         */
    427427        $site_name = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );
     
    446446     * @since 4.4.0 Added the `$user_login` and `$user_data` parameters.
    447447     *
    448      * @param string  $title      Default email title.
     448     * @param string  $title      Email subject.
    449449     * @param string  $user_login The username for the user.
    450450     * @param WP_User $user_data  WP_User object.
     
    460460     * @since 4.1.0 Added `$user_login` and `$user_data` parameters.
    461461     *
    462      * @param string  $message    Default mail message.
     462     * @param string  $message    Email message.
    463463     * @param string  $key        The activation key.
    464464     * @param string  $user_login The username for the user.
  • trunk/src/wp-signup.php

    r48590 r49078  
    241241
    242242/**
    243  * Display user registration form
     243 * Displays the fields for the new user account registration form.
    244244 *
    245245 * @since MU (3.0.0)
     
    278278    }
    279279    /**
    280      * Fires at the end of the user registration form on the site sign-up form.
     280     * Fires at the end of the new user account registration form.
    281281     *
    282282     * @since 3.0.0
     
    548548
    549549/**
    550  * Setup the new user signup process
     550 * Shows a form for a visitor to sign up for a new user account.
    551551 *
    552552 * @since MU (3.0.0)
     
    684684
    685685/**
    686  * Setup the new site signup
     686 * Shows a form for a user or visitor to sign up for a new site.
    687687 *
    688688 * @since MU (3.0.0)
     
    808808
    809809/**
    810  * New site signup confirmation
    811  *
    812  * @since MU (3.0.0)
    813  *
    814  * @param string $domain     The domain URL.
    815  * @param string $path       The site root path.
    816  * @param string $blog_title The new site title.
     810 * Shows a message confirming that the new site has been registered and is awaiting activation.
     811 *
     812 * @since MU (3.0.0)
     813 *
     814 * @param string $domain     The domain or subdomain of the site.
     815 * @param string $path       The path of the site.
     816 * @param string $blog_title The title of the new site.
    817817 * @param string $user_name  The user's username.
    818818 * @param string $user_email The user's email address.
Note: See TracChangeset for help on using the changeset viewer.