WordPress.org

Make WordPress Core

Changeset 47368


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

Docs: In wp_insert_user(), clarify that rich_editing, syntax_highlighting, comment_shortcuts, and show_admin_bar_front arguments accept true or false as a string literal, not boolean.

Props garrett-eclipse, audrasjb, valentinbora, bilgilabs, SergeyBiryukov.
Fixes #49087.

File:
1 edited

Legend:

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

    r47279 r47368  
    15031503 *     @type string      $description          The user's biographical description.
    15041504 *     @type string|bool $rich_editing         Whether to enable the rich-editor for the user.
    1505  *                                             False if not empty.
     1505 *                                             Accepts 'true' or 'false' as a string literal,
     1506 *                                             not boolean. Default 'true'.
    15061507 *     @type string|bool $syntax_highlighting  Whether to enable the rich code editor for the user.
    1507  *                                             False if not empty.
     1508 *                                             Accepts 'true' or 'false' as a string literal,
     1509 *                                             not boolean. Default 'true'.
    15081510 *     @type string|bool $comment_shortcuts    Whether to enable comment moderation keyboard
    1509  *                                             shortcuts for the user. Default false.
     1511 *                                             shortcuts for the user. Accepts 'true' or 'false'
     1512 *                                             as a string literal, not boolean. Default 'false'.
    15101513 *     @type string      $admin_color          Admin color scheme for the user. Default 'fresh'.
    15111514 *     @type bool        $use_ssl              Whether the user should always access the admin over
     
    15151518 *     @type bool        $spam                 Multisite only. Whether the user is marked as spam.
    15161519 *                                             Default false.
    1517  *     @type string|bool $show_admin_bar_front Whether to display the Admin Bar for the user on the
    1518  *                                             site's front end. Default true.
     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'.
    15191523 *     @type string      $role                 User's role.
    15201524 *     @type string      $locale               User's locale. Default empty.
     
    18271831     *     @type string   $last_name            The user's last name.
    18281832     *     @type string   $description          The user's description.
    1829      *     @type bool     $rich_editing         Whether to enable the rich-editor for the user. False if not empty.
    1830      *     @type bool     $syntax_highlighting  Whether to enable the rich code editor for the user. False if not empty.
    1831      *     @type bool     $comment_shortcuts    Whether to enable keyboard shortcuts for the user. Default false.
     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'.
    18321836     *     @type string   $admin_color          The color scheme for a user's admin screen. Default 'fresh'.
    18331837     *     @type int|bool $use_ssl              Whether to force SSL on the user's admin area. 0|false if SSL is
    18341838     *                                          not forced.
    18351839     *     @type bool     $show_admin_bar_front Whether to show the admin bar on the front end for the user.
    1836      *                                          Default true.
     1840     *                                          Default 'true'.
    18371841     *     @type string   $locale               User's locale. Default empty.
    18381842     * }
Note: See TracChangeset for help on using the changeset viewer.