username_exists() – Determines whether the given username exists.

You appear to be a bot. Output may be restricted

Description

Determines whether the given username exists.

For more information on this and similar theme functions, check out the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ Conditional Tags} article in the Theme Developer Handbook.

Usage

$int|false = username_exists( $username );

Parameters

$username
( string ) required – The username to check for existence.

Returns

int|false The user ID on success, false on failure.

Source

File name: wordpress/wp-includes/user.php
Lines:

1 to 19 of 19
function username_exists( $username ) {
  $user = get_user_by( 'login', $username );
  if ( $user ) {
    $user_id = $user->ID;
  } else {
    $user_id = false;
  }

  
/**
 * Filters whether the given username exists.
 *
 * @since 4.9.0
 *
 * @param int|false $user_id  The user ID associated with the username,
 *                            or false if the username does not exist.
 * @param string    $username The username to check for existence.
 */
  return apply_filters( 'username_exists', $user_id, $username );
}
 

 View on GitHub View on Trac