sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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

Browse Source 
Follow-up to [47368].

See #49087.

git-svn-id: https://develop.svn.wordpress.org/trunk@47369 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2020-02-25 18:18:26 +00:00
parent d722bdb0ac
commit 8dbe048737
1 changed files with 44 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
src/wp-includes/user.php
View File

@ -1501,13 +1501,13 @@ function validate_username( $username ) {
* to build the second part of the user's display name * to build the second part of the user's display name
* if `$display_name` is not specified. * if `$display_name` is not specified.
* @type string $description The user's biographical description. * @type string $description The user's biographical description.
* @type string|bool $rich_editing Whether to enable the rich-editor for the user. * @type string $rich_editing Whether to enable the rich-editor for the user.
* Accepts 'true' or 'false' as a string literal, * Accepts 'true' or 'false' as a string literal,
* not boolean. Default 'true'. * not boolean. Default 'true'.
* @type string|bool $syntax_highlighting Whether to enable the rich code editor for the user. * @type string $syntax_highlighting Whether to enable the rich code editor for the user.
* Accepts 'true' or 'false' as a string literal, * Accepts 'true' or 'false' as a string literal,
* not boolean. Default 'true'. * not boolean. Default 'true'.
* @type string|bool $comment_shortcuts Whether to enable comment moderation keyboard * @type string $comment_shortcuts Whether to enable comment moderation keyboard
* shortcuts for the user. Accepts 'true' or 'false' * shortcuts for the user. Accepts 'true' or 'false'
* as a string literal, not boolean. Default 'false'. * as a string literal, not boolean. Default 'false'.
* @type string $admin_color Admin color scheme for the user. Default 'fresh'. * @type string $admin_color Admin color scheme for the user. Default 'fresh'.
@ -1517,7 +1517,7 @@ function validate_username( $username ) {
* @type string $user_activation_key Password reset key. Default empty. * @type string $user_activation_key Password reset key. Default empty.
* @type bool $spam Multisite only. Whether the user is marked as spam. * @type bool $spam Multisite only. Whether the user is marked as spam.
* Default false. * Default false.
* @type string|bool $show_admin_bar_front Whether to display the Admin Bar for the user * @type string $show_admin_bar_front Whether to display the Admin Bar for the user
* on the site's front end. Accepts 'true' or 'false' * on the site's front end. Accepts 'true' or 'false'
* as a string literal, not boolean. Default 'true'. * as a string literal, not boolean. Default 'true'.
* @type string $role User's role. * @type string $role User's role.
@ -1830,13 +1830,13 @@ function wp_insert_user( $userdata ) {
* @type string $first_name The user's first name. * @type string $first_name The user's first name.
* @type string $last_name The user's last name. * @type string $last_name The user's last name.
* @type string $description The user's description. * @type string $description The user's description.
* @type bool $rich_editing Whether to enable the rich-editor for the user. Default 'true'. * @type string $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 string $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 $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 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 * @type int|bool $use_ssl Whether to force SSL on the user's admin area. 0|false if SSL
* not forced. * is not forced.
* @type bool $show_admin_bar_front Whether to show the admin bar on the front end for the user. * @type string $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. * @type string $locale User's locale. Default empty.
* } * }