Make WordPress Core


Ignore:
Timestamp:
08/31/2021 12:23:46 PM (3 years ago)
Author:
SergeyBiryukov
Message:

Docs: Improve documentation in wp-signup.php.

  • Document the $active_signup global in signup_user().
  • Update some DocBlocks per the documentation standards.
  • Expand some function descriptions for clarity.

Follow-up to [37535], [37536], [41200], [43326], [49078], [50828].

Props mt8.biz, sabernhardt, audrasjb, westonruter, jayupadhyay01, mukesh27, SergeyBiryukov.
Fixes #41566.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-signup.php

    r50828 r51699  
    1616
    1717/**
    18  * Prints signup_header via wp_head
     18 * Prints signup_header via wp_head.
    1919 *
    2020 * @since MU (3.0.0)
     
    5151
    5252/**
    53  * Prints styles for front-end Multisite signup pages
     53 * Prints styles for front-end Multisite signup pages.
    5454 *
    5555 * @since MU (3.0.0)
     
    9090<?php
    9191/**
    92  * Generates and displays the Signup and Create Site forms
     92 * Generates and displays the Signup and Create Site forms.
    9393 *
    9494 * @since MU (3.0.0)
     
    225225
    226226/**
    227  * Validate the new site signup
     227 * Validates the new site signup.
    228228 *
    229229 * @since MU (3.0.0)
     
    289289
    290290/**
    291  * Validate user signup name and email
     291 * Validates user signup name and email.
    292292 *
    293293 * @since MU (3.0.0)
     
    301301
    302302/**
    303  * Allow returning users to sign up for another site
     303 * Shows a form for returning users to sign up for another site.
    304304 *
    305305 * @since MU (3.0.0)
     
    395395
    396396/**
    397  * Validate a new site signup for an existing user.
    398  *
    399  * @global string          $blogname   The new site's subdomain or directory name.
    400  * @global string          $blog_title The new site's title.
    401  * @global WP_Error        $errors     Existing errors in the global scope.
    402  * @global string          $domain     The new site's domain.
    403  * @global string          $path       The new site's path.
    404  *
    405  * @since MU (3.0.0)
    406  *
    407  * @return null|bool True if site signup was validated, false if error.
     397 * Validates a new site signup for an existing user.
     398 *
     399 * @since MU (3.0.0)
     400 *
     401 * @global string   $blogname   The new site's subdomain or directory name.
     402 * @global string   $blog_title The new site's title.
     403 * @global WP_Error $errors     Existing errors in the global scope.
     404 * @global string   $domain     The new site's domain.
     405 * @global string   $path       The new site's path.
     406 *
     407 * @return null|bool True if site signup was validated, false on error.
    408408 *                   The function halts all execution if the user is not logged in.
    409409 */
     
    487487
    488488/**
    489  * Confirm a new site signup.
     489 * Shows a message confirming that the new site has been created.
    490490 *
    491491 * @since MU (3.0.0)
     
    554554 * @since MU (3.0.0)
    555555 *
     556 * @global string $active_signup String that returns registration type. The value can be
     557 *                               'all', 'none', 'blog', or 'user'.
     558 *
    556559 * @param string          $user_name  The username.
    557560 * @param string          $user_email The user's email.
     
    627630
    628631/**
    629  * Validate the new user signup
    630  *
    631  * @since MU (3.0.0)
    632  *
    633  * @return bool True if new user signup was validated, false if error
     632 * Validates the new user signup.
     633 *
     634 * @since MU (3.0.0)
     635 *
     636 * @return bool True if new user signup was validated, false on error.
    634637 */
    635638function validate_user_signup() {
     
    657660
    658661/**
    659  * New user signup confirmation
    660  *
    661  * @since MU (3.0.0)
    662  *
    663  * @param string $user_name The username
    664  * @param string $user_email The user's email address
     662 * Shows a message confirming that the new user has been registered and is awaiting activation.
     663 *
     664 * @since MU (3.0.0)
     665 *
     666 * @param string $user_name  The username.
     667 * @param string $user_email The user's email address.
    665668 */
    666669function confirm_user_signup( $user_name, $user_email ) {
     
    751754
    752755/**
    753  * Validate new site signup
    754  *
    755  * @since MU (3.0.0)
    756  *
    757  * @return bool True if the site signup was validated, false if error
     756 * Validates new site signup.
     757 *
     758 * @since MU (3.0.0)
     759 *
     760 * @return bool True if the site signup was validated, false on error.
    758761 */
    759762function validate_blog_signup() {
Note: See TracChangeset for help on using the changeset viewer.