Changeset 47368

Timestamp:

02/25/2020 06:15:00 PM (5 years 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:

• trunk/src/wp-includes/user.php (modified) (3 diffs)

trunk/src/wp-includes/user.php

@@ -1503 +1503 @@
  *     @type string      $description          The user's biographical description.
  *     @type string|bool $rich_editing         Whether to enable the rich-editor for the user.
- *                                             False if not empty.
+ *                                             Accepts 'true' or 'false' as a string literal,
+ *                                             not boolean. Default 'true'.
  *     @type string|bool $syntax_highlighting  Whether to enable the rich code editor for the user.
- *                                             False if not empty.
+ *                                             Accepts 'true' or 'false' as a string literal,
+ *                                             not boolean. Default 'true'.
  *     @type string|bool $comment_shortcuts    Whether to enable comment moderation keyboard
- *                                             shortcuts for the user. Default false.
+ *                                             shortcuts for the user. Accepts 'true' or 'false'
+ *                                             as a string literal, not boolean. Default 'false'.
  *     @type string      $admin_color          Admin color scheme for the user. Default 'fresh'.
  *     @type bool        $use_ssl              Whether the user should always access the admin over
@@ -1515 +1518 @@
  *     @type bool        $spam                 Multisite only. Whether the user is marked as spam.
  *                                             Default false.
- *     @type string|bool $show_admin_bar_front Whether to display the Admin Bar for the user on the
- *                                             site's front end. Default true.
+ *     @type string|bool $show_admin_bar_front Whether to display the Admin Bar for the user
+ *                                             on the site's front end. Accepts 'true' or 'false'
+ *                                             as a string literal, not boolean. Default 'true'.
  *     @type string      $role                 User's role.
  *     @type string      $locale               User's locale. Default empty.
@@ -1827 +1831 @@
      *     @type string   $last_name            The user's last name.
      *     @type string   $description          The user's description.
-     *     @type bool     $rich_editing         Whether to enable the rich-editor for the user. False if not empty.
-     *     @type bool     $syntax_highlighting  Whether to enable the rich code editor for the user. False if not empty.
-     *     @type bool     $comment_shortcuts    Whether to enable keyboard shortcuts for the user. Default false.
+     *     @type bool     $rich_editing         Whether to enable the rich-editor for the user. Default 'true'.
+     *     @type bool     $syntax_highlighting  Whether to enable the rich code editor for the user. Default 'true'.
+     *     @type bool     $comment_shortcuts    Whether to enable keyboard shortcuts for the user. Default 'false'.
      *     @type string   $admin_color          The color scheme for a user's admin screen. Default 'fresh'.
      *     @type int|bool $use_ssl              Whether to force SSL on the user's admin area. 0|false if SSL is
      *                                          not forced.
      *     @type bool     $show_admin_bar_front Whether to show the admin bar on the front end for the user.
-     *                                          Default true.
+     *                                          Default 'true'.
      *     @type string   $locale               User's locale. Default empty.
      * }