username_exists( string $username )

Determines whether the given username exists.

Contents

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

1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
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 );
}

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
2.0.0 Introduced.

Top ↑

Top ↑

Uses Uses

Uses
Uses Description
wp-includes/user.php: username_exists

Filters whether the given username exists or not.
wp-includes/pluggable.php: get_user_by()

Retrieve user info by a given field
wp-includes/plugin.php: apply_filters()

Call the functions added to a filter hook.

Top ↑

Used By Used By

Used By
Used By Description
wp-admin/includes/upgrade.php: wp_install()

Installs the site.
wp-admin/includes/user.php: edit_user()

Edit user settings based on contents of $_POST
wp-admin/includes/class-wp-importer.php: WP_Importer::set_user()
wp-includes/user.php: register_new_user()

Handles registering a new user.
wp-includes/user.php: wp_insert_user()

Insert a user into the database.
wp-includes/ms-functions.php: wpmu_activate_signup()

Activate a signup.
wp-includes/ms-functions.php: wpmu_validate_user_signup()

Sanitize and validate data required for a user sign-up.
wp-includes/ms-functions.php: wpmu_validate_blog_signup()

Processes new site registrations.
Show 3 more used by Hide more used by

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: -1You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Example
    Use username_exists() in your scripts to decide whether the given username exists.

    1
    2
    3
    4
    5
    6
    $username = sanitize_text_field( $_POST['username'] );
    if ( username_exists( $username ) ) {
        echo "Username In Use!";
    } else {
        echo "Username Not In Use!";
    }

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