wp_signon( array $credentials = array(), string|bool $secure_cookie = '' ): WP_User|WP_Error

Description

Parameters

$credentialsarrayoptional

User info in order to sign on.Default: array()

• $user_loginstring

  Username.

• $user_passwordstring

  User password.

• $rememberbooldefault: false

  Whether to 'remember' the user. Increases the time that the cookie will be kept.

$secure_cookiestring|booloptional

Whether to use secure cookie.Default: ''

Return

WP_User|WP_Error

WP_User on success, WP_Error on failure.

Hooks fired · 3

3 hooks fire while wp_signon() runs, in this order:

1. 1
   do_action( wp_authenticate )actionline 81 (+40 into the body)

   Fires before the user is authenticated.

2. 2
   apply_filters( secure_signon_cookie )filterline 102 (+61 into the body)

   Filters whether to use a secure sign-on cookie.

3. 3
   do_action( wp_login )actionline 138 (+97 into the body)

   Fires after the user has successfully logged in.

Uses · 9

• wp_unslash()Removes slashes from a string or recursively removes slashes from strings within an array.
• do_action_ref_array()Calls the callback functions that have been added to an action hook, specifying arguments in an array.
• is_ssl()Determines if SSL is used.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• add_filter()Adds a callback function to a filter hook.
• wp_authenticate()Authenticates a user, confirming the login credentials are valid.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_set_auth_cookie()Sets the authentication cookies based on user ID.
• do_action()Calls the callback functions that have been added to an action hook.

Source

View on Trac ↗View on GitHub ↗

41function wp_signon( $credentials = array(), $secure_cookie = '' ) {42	global $auth_secure_cookie, $wpdb;43 44	if ( empty( $credentials ) ) {45		$credentials = array(46			'user_login'    => '',47			'user_password' => '',48			'remember'      => false,49		);50 51		if ( ! empty( $_POST['log'] ) ) {52			$credentials['user_login'] = wp_unslash( $_POST['log'] );53		}54		if ( ! empty( $_POST['pwd'] ) ) {55			$credentials['user_password'] = $_POST['pwd'];56		}57		if ( ! empty( $_POST['rememberme'] ) ) {58			$credentials['remember'] = $_POST['rememberme'];59		}60	}61 62	if ( ! empty( $credentials['remember'] ) ) {63		$credentials['remember'] = true;64	} else {65		$credentials['remember'] = false;66	}67 68	/**69	 * Fires before the user is authenticated.70	 *71	 * The variables passed to the callbacks are passed by reference,72	 * and can be modified by callback functions.73	 *74	 * @since 1.5.175	 *76	 * @todo Decide whether to deprecate the wp_authenticate action.77	 *78	 * @param string $user_login    Username (passed by reference).79	 * @param string $user_password User password (passed by reference).80	 */81	do_action_ref_array( 'wp_authenticate', array( &$credentials['user_login'], &$credentials['user_password'] ) );82 83	if ( '' === $secure_cookie ) {84		$secure_cookie = is_ssl();85	}86 87	/**88	 * Filters whether to use a secure sign-on cookie.89	 *90	 * @since 3.1.091	 *92	 * @param bool  $secure_cookie Whether to use a secure sign-on cookie.93	 * @param array $credentials {94	 *     Array of entered sign-on data.95	 *96	 *     @type string $user_login    Username.97	 *     @type string $user_password Password entered.98	 *     @type bool   $remember      Whether to 'remember' the user. Increases the time99	 *                                 that the cookie will be kept. Default false.100	 * }101	 */102	$secure_cookie = apply_filters( 'secure_signon_cookie', $secure_cookie, $credentials );103 104	// XXX ugly hack to pass this to wp_authenticate_cookie().105	$auth_secure_cookie = $secure_cookie;106 107	add_filter( 'authenticate', 'wp_authenticate_cookie', 30, 3 );108 109	$user = wp_authenticate( $credentials['user_login'], $credentials['user_password'] );110 111	if ( is_wp_error( $user ) ) {112		return $user;113	}114 115	wp_set_auth_cookie( $user->ID, $credentials['remember'], $secure_cookie );116 117	// Clear `user_activation_key` after a successful login.118	if ( ! empty( $user->user_activation_key ) ) {119		$wpdb->update(120			$wpdb->users,

History

Introduced in 2.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/user.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.