WordPress.org

Make WordPress Core


Ignore:
Timestamp:
11/05/2019 09:21:46 PM (18 months ago)
Author:
johnbillion
Message:

Docs: Improve documentation of known return types, plus other docs fixes.

See #48303

File:
1 edited

Legend:

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

    r46644 r46660  
    1313 * @since MU (3.0.0)
    1414 *
    15  * @return array Site and user count for the network.
     15 * @return int[] {
     16 *     Site and user count for the network.
     17 *
     18 *     @type int $blogs Number of sites on the network.
     19 *     @type int $users Number of users on the network.
     20 * }
    1621 */
    1722function get_sitestats() {
     
    444449 * @param string $user_name  The login name provided by the user.
    445450 * @param string $user_email The email provided by the user.
    446  * @return array Contains username, email, and error messages.
     451 * @return array {
     452 *     The array of user name, email, and the error messages.
     453 *
     454 *     @type string   $user_name     Sanitized and unique username.
     455 *     @type string   $orig_username Original username.
     456 *     @type string   $user_email    User email address.
     457 *     @type WP_Error $errors        WP_Error object containing any errors found.
     458 * }
    447459 */
    448460function wpmu_validate_user_signup( $user_name, $user_email ) {
     
    560572     *
    561573     * @param array $result {
    562      *     The array of user name, email and the error messages.
     574     *     The array of user name, email, and the error messages.
    563575     *
    564576     *     @type string   $user_name     Sanitized and unique username.
     
    593605 * @param string         $blog_title The blog title provided by the user.
    594606 * @param WP_User|string $user       Optional. The user object to check against the new site name.
    595  * @return array Contains the new site data and error messages.
     607 * @return array {
     608 *     Array of domain, path, blog name, blog title, user and error messages.
     609 *
     610 *     @type string         $domain     Domain for the site.
     611 *     @type string         $path       Path for the site. Used in subdirectory installations.
     612 *     @type string         $blogname   The unique site name (slug).
     613 *     @type string         $blog_title Blog title.
     614 *     @type string|WP_User $user       By default, an empty string. A user object if provided.
     615 *     @type WP_Error       $errors     WP_Error containing any errors found.
     616 * }
    596617 */
    597618function wpmu_validate_blog_signup( $blogname, $blog_title, $user = '' ) {
     
    19741995 *
    19751996 * @param array|string $deprecated Not used.
    1976  * @return array The current site's domain
     1997 * @return string[] {
     1998 *     An array containing the current site's domain.
     1999 *
     2000 *     @type string $0 The current site's domain.
     2001 * }
    19772002 */
    19782003function redirect_this_site( $deprecated = '' ) {
     
    25782603 * @since 4.4.0
    25792604 *
    2580  * @return array Array of reserved subdirectory names.
     2605 * @return string[] Array of reserved names.
    25812606 */
    25822607function get_subdirectory_reserved_names() {
Note: See TracChangeset for help on using the changeset viewer.