WordPress.org

Make WordPress Core

Changeset 47369


Ignore:
Timestamp:
02/25/2020 06:18:26 PM (3 months ago)
Author:
SergeyBiryukov
Message:

Docs: In wp_insert_user(), correct @type for rich_editing, syntax_highlighting, comment_shortcuts, and show_admin_bar_front arguments.

Follow-up to [47368].

See #49087.

File:
1 edited

Legend:

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

    r47368 r47369  
    14851485 *     An array, object, or WP_User object of user data arguments.
    14861486 *
    1487  *     @type int         $ID                   User ID. If supplied, the user will be updated.
    1488  *     @type string      $user_pass            The plain-text user password.
    1489  *     @type string      $user_login           The user's login username.
    1490  *     @type string      $user_nicename        The URL-friendly user name.
    1491  *     @type string      $user_url             The user URL.
    1492  *     @type string      $user_email           The user email address.
    1493  *     @type string      $display_name         The user's display name.
    1494  *                                             Default is the user's username.
    1495  *     @type string      $nickname             The user's nickname.
    1496  *                                             Default is the user's username.
    1497  *     @type string      $first_name           The user's first name. For new users, will be used
    1498  *                                             to build the first part of the user's display name
    1499  *                                             if `$display_name` is not specified.
    1500  *     @type string      $last_name            The user's last name. For new users, will be used
    1501  *                                             to build the second part of the user's display name
    1502  *                                             if `$display_name` is not specified.
    1503  *     @type string      $description          The user's biographical description.
    1504  *     @type string|bool $rich_editing         Whether to enable the rich-editor for the user.
    1505  *                                             Accepts 'true' or 'false' as a string literal,
    1506  *                                             not boolean. Default 'true'.
    1507  *     @type string|bool $syntax_highlighting  Whether to enable the rich code editor for the user.
    1508  *                                             Accepts 'true' or 'false' as a string literal,
    1509  *                                             not boolean. Default 'true'.
    1510  *     @type string|bool $comment_shortcuts    Whether to enable comment moderation keyboard
    1511  *                                             shortcuts for the user. Accepts 'true' or 'false'
    1512  *                                             as a string literal, not boolean. Default 'false'.
    1513  *     @type string      $admin_color          Admin color scheme for the user. Default 'fresh'.
    1514  *     @type bool        $use_ssl              Whether the user should always access the admin over
    1515  *                                             https. Default false.
    1516  *     @type string      $user_registered      Date the user registered. Format is 'Y-m-d H:i:s'.
    1517  *     @type string      $user_activation_key  Password reset key. Default empty.
    1518  *     @type bool        $spam                 Multisite only. Whether the user is marked as spam.
    1519  *                                             Default false.
    1520  *     @type string|bool $show_admin_bar_front Whether to display the Admin Bar for the user
    1521  *                                             on the site's front end. Accepts 'true' or 'false'
    1522  *                                             as a string literal, not boolean. Default 'true'.
    1523  *     @type string      $role                 User's role.
    1524  *     @type string      $locale               User's locale. Default empty.
     1487 *     @type int    $ID                   User ID. If supplied, the user will be updated.
     1488 *     @type string $user_pass            The plain-text user password.
     1489 *     @type string $user_login           The user's login username.
     1490 *     @type string $user_nicename        The URL-friendly user name.
     1491 *     @type string $user_url             The user URL.
     1492 *     @type string $user_email           The user email address.
     1493 *     @type string $display_name         The user's display name.
     1494 *                                        Default is the user's username.
     1495 *     @type string $nickname             The user's nickname.
     1496 *                                        Default is the user's username.
     1497 *     @type string $first_name           The user's first name. For new users, will be used
     1498 *                                        to build the first part of the user's display name
     1499 *                                        if `$display_name` is not specified.
     1500 *     @type string $last_name            The user's last name. For new users, will be used
     1501 *                                        to build the second part of the user's display name
     1502 *                                        if `$display_name` is not specified.
     1503 *     @type string $description          The user's biographical description.
     1504 *     @type string $rich_editing         Whether to enable the rich-editor for the user.
     1505 *                                        Accepts 'true' or 'false' as a string literal,
     1506 *                                        not boolean. Default 'true'.
     1507 *     @type string $syntax_highlighting  Whether to enable the rich code editor for the user.
     1508 *                                        Accepts 'true' or 'false' as a string literal,
     1509 *                                        not boolean. Default 'true'.
     1510 *     @type string $comment_shortcuts    Whether to enable comment moderation keyboard
     1511 *                                        shortcuts for the user. Accepts 'true' or 'false'
     1512 *                                        as a string literal, not boolean. Default 'false'.
     1513 *     @type string $admin_color          Admin color scheme for the user. Default 'fresh'.
     1514 *     @type bool   $use_ssl              Whether the user should always access the admin over
     1515 *                                        https. Default false.
     1516 *     @type string $user_registered      Date the user registered. Format is 'Y-m-d H:i:s'.
     1517 *     @type string $user_activation_key  Password reset key. Default empty.
     1518 *     @type bool   $spam                 Multisite only. Whether the user is marked as spam.
     1519 *                                        Default false.
     1520 *     @type string $show_admin_bar_front Whether to display the Admin Bar for the user
     1521 *                                        on the site's front end. Accepts 'true' or 'false'
     1522 *                                        as a string literal, not boolean. Default 'true'.
     1523 *     @type string $role                 User's role.
     1524 *     @type string $locale               User's locale. Default empty.
    15251525 * }
    15261526 * @return int|WP_Error The newly created user's ID or a WP_Error object if the user could not
     
    18311831     *     @type string   $last_name            The user's last name.
    18321832     *     @type string   $description          The user's description.
    1833      *     @type bool     $rich_editing         Whether to enable the rich-editor for the user. Default 'true'.
    1834      *     @type bool     $syntax_highlighting  Whether to enable the rich code editor for the user. Default 'true'.
    1835      *     @type bool     $comment_shortcuts    Whether to enable keyboard shortcuts for the user. Default 'false'.
     1833     *     @type string   $rich_editing         Whether to enable the rich-editor for the user. Default 'true'.
     1834     *     @type string   $syntax_highlighting  Whether to enable the rich code editor for the user. Default 'true'.
     1835     *     @type string   $comment_shortcuts    Whether to enable keyboard shortcuts for the user. Default 'false'.
    18361836     *     @type string   $admin_color          The color scheme for a user's admin screen. Default 'fresh'.
    1837      *     @type int|bool $use_ssl              Whether to force SSL on the user's admin area. 0|false if SSL is
    1838      *                                          not forced.
    1839      *     @type bool     $show_admin_bar_front Whether to show the admin bar on the front end for the user.
     1837     *     @type int|bool $use_ssl              Whether to force SSL on the user's admin area. 0|false if SSL
     1838     *                                          is not forced.
     1839     *     @type string   $show_admin_bar_front Whether to show the admin bar on the front end for the user.
    18401840     *                                          Default 'true'.
    18411841     *     @type string   $locale               User's locale. Default empty.
Note: See TracChangeset for help on using the changeset viewer.