phpDoc for wp-includes/registration.php. fixes #4383
git-svn-id: https://develop.svn.wordpress.org/trunk@5627 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
parent
a79b7c6772
commit
21ad1a92f8
|
@ -1,34 +1,47 @@
|
||||||
<?php
|
<?php
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Checks whether the given username exists.
|
||||||
|
* @param string $username Username.
|
||||||
|
* @return mixed The user's ID on success, and null on failure.
|
||||||
|
*/
|
||||||
function username_exists( $username ) {
|
function username_exists( $username ) {
|
||||||
global $wpdb;
|
if ( $user = get_userdatabylogin( sanitize_user( $username ) ) ) {
|
||||||
$username = sanitize_user( $username );
|
|
||||||
$user = get_userdatabylogin($username);
|
|
||||||
if ( $user )
|
|
||||||
return $user->ID;
|
return $user->ID;
|
||||||
|
} else {
|
||||||
return null;
|
return null;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Checks whether the given email exists.
|
||||||
|
* @global object $wpdb WordPress database layer.
|
||||||
|
* @param string $email Email.
|
||||||
|
* @return mixed The user's ID on success, and false on failure.
|
||||||
|
*/
|
||||||
function email_exists( $email ) {
|
function email_exists( $email ) {
|
||||||
global $wpdb;
|
global $wpdb;
|
||||||
$email = addslashes( $email );
|
$email = $wpdb->escape( $email );
|
||||||
return $wpdb->get_var("SELECT ID FROM $wpdb->users WHERE user_email = '$email'");
|
return $wpdb->get_var( "SELECT ID FROM $wpdb->users WHERE user_email = '$email'" );
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Checks whether an username is valid.
|
||||||
|
* @param string $username Username.
|
||||||
|
* @return bool A filtered boolean.
|
||||||
|
*/
|
||||||
function validate_username( $username ) {
|
function validate_username( $username ) {
|
||||||
$name = sanitize_user($username, true);
|
$sanitized = sanitize_user( $username, true );
|
||||||
$valid = true;
|
$valid = ( $sanitized == $username );
|
||||||
|
return apply_filters( 'validate_username', $valid, $username );
|
||||||
if ( $name != $username )
|
|
||||||
$valid = false;
|
|
||||||
|
|
||||||
return apply_filters('validate_username', $valid, $username);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Insert an user into the database.
|
||||||
|
* @global object $wpdb WordPress database layer.
|
||||||
|
* @param array $userdata An array of user data.
|
||||||
|
* @return int The newly created user's ID.
|
||||||
|
*/
|
||||||
function wp_insert_user($userdata) {
|
function wp_insert_user($userdata) {
|
||||||
global $wpdb;
|
global $wpdb;
|
||||||
|
|
||||||
|
@ -130,7 +143,12 @@ function wp_insert_user($userdata) {
|
||||||
return $user_id;
|
return $user_id;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Update an user in the database.
|
||||||
|
* @global object $wpdb WordPress database layer.
|
||||||
|
* @param array $userdata An array of user data.
|
||||||
|
* @return int The updated user's ID.
|
||||||
|
*/
|
||||||
function wp_update_user($userdata) {
|
function wp_update_user($userdata) {
|
||||||
global $wpdb;
|
global $wpdb;
|
||||||
|
|
||||||
|
@ -164,7 +182,15 @@ function wp_update_user($userdata) {
|
||||||
return $user_id;
|
return $user_id;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A simpler way of inserting an user into the database.
|
||||||
|
* See also: wp_insert_user().
|
||||||
|
* @global object $wpdb WordPress database layer.
|
||||||
|
* @param string $username The user's username.
|
||||||
|
* @param string $password The user's password.
|
||||||
|
* @param string $email The user's email (optional).
|
||||||
|
* @return int The new user's ID.
|
||||||
|
*/
|
||||||
function wp_create_user($username, $password, $email = '') {
|
function wp_create_user($username, $password, $email = '') {
|
||||||
global $wpdb;
|
global $wpdb;
|
||||||
|
|
||||||
|
@ -176,7 +202,14 @@ function wp_create_user($username, $password, $email = '') {
|
||||||
return wp_insert_user($userdata);
|
return wp_insert_user($userdata);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An alias of wp_create_user().
|
||||||
|
* @param string $username The user's username.
|
||||||
|
* @param string $password The user's password.
|
||||||
|
* @param string $email The user's email (optional).
|
||||||
|
* @return int The new user's ID.
|
||||||
|
* @deprecated
|
||||||
|
*/
|
||||||
function create_user($username, $password, $email) {
|
function create_user($username, $password, $email) {
|
||||||
return wp_create_user($username, $password, $email);
|
return wp_create_user($username, $password, $email);
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue