username_exists( string $username )

Determines whether the given username exists.


Description Description

For more information on this and similar theme functions, check out the Conditional Tags article in the Theme Developer Handbook.


Parameters Parameters

$username

(string) (Required) Username.


Top ↑

Return Return

(int|false) The user's ID on success, and false on failure.


Top ↑

Source Source

File: wp-includes/user.php

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 or not.
	 *
	 * @since 4.9.0
	 *
	 * @param int|false $user_id  The user's ID on success, and false on failure.
	 * @param string    $username Username to check.
	 */
	return apply_filters( 'username_exists', $user_id, $username );
}

Top ↑

Changelog Changelog

Changelog
Version Description
2.0.0 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.