Docs: Clarify the return description for `wp_create_user()` to illustrate that a `WP_Error` object will be returned on failure.

Props jmayhak
Fixes #33321.

Built from https://develop.svn.wordpress.org/trunk@33725


git-svn-id: http://core.svn.wordpress.org/trunk@33693 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2015-08-24 22:23:24 +00:00
parent 8a95b13cab
commit dbdc8bf149
2 changed files with 3 additions and 2 deletions

View File

@ -2365,7 +2365,8 @@ All at ###SITENAME###
* @param string $username The user's username. * @param string $username The user's username.
* @param string $password The user's password. * @param string $password The user's password.
* @param string $email Optional. The user's email. Default empty. * @param string $email Optional. The user's email. Default empty.
* @return int|WP_Error The new user's ID. * @return int|WP_Error The newly created user's ID or a WP_Error object if the user could not
* be created.
*/ */
function wp_create_user($username, $password, $email = '') { function wp_create_user($username, $password, $email = '') {
$user_login = wp_slash( $username ); $user_login = wp_slash( $username );

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.4-alpha-33724'; $wp_version = '4.4-alpha-33725';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.