Codex

Function Reference/wp signon

Contents

Description

Authenticates a user with option to remember credentials. Replaces deprecated function wp_login.

Usage

 <?php wp_signon( $credentials, $secure_cookie ) ?> 

Parameters

$credentials
(array) (optional) User info in order to sign on.
Default: None
$secure_cookie
(boolean) (optional) Whether to use secure cookie.
Default: None

NOTE: If you don't provide $credentials, wp_signon uses the $_POST variable.

Return Value

(object) 
Either WP_Error on failure, or WP_User on success.

Examples

Change Log

Since: 2.5.0

Source File

wp_signon() is located in wp-includes/user.php.

Related

See also index of Function Reference and index of Template Tags.
Retrieved from "http://codex.wordpress.org/Function_Reference/wp_signon"

Codex Resources