API Documentation
Back to top  

package BackPress

 Methods

WP_Auth() 

WP_Auth($db, $users, $cookies) 

Parameters

$db

$users

$cookies

__construct() 

__construct($db, $users, array $cookies) 
link

Parameters

$db

$users

$cookies

array

Array indexed by internal name of cookie. Values are arrays of array defining cookie parameters. $cookies = array( 'auth' => array( 0 => array( 'domain' => (string) cookie domain 'path' => (string) cookie path 'name' => (string) cookie name 'secure' => (bool) restrict cookie to HTTPS only ) ) );

At least one cookie is required. Give it an internal name of 'auth'.

Suggested cookie structure: logged_in: whether or not a user is logged in. Send everywhere. auth: used to authorize user's actions. Send only to domains/paths that need it (e.g. wp-admin/) secure_auth: used to authorize user's actions. Send only to domains/paths that need it and only over HTTPS

You should be very careful when setting cookie domain to ensure that it always follows the rules set out in the {@link http://curl.haxx.se/rfc/cookie_spec.html Set Cookie spec}. In most cases it is best to leave cookie set to false and allow for user configuration to define a cookie domain in a configuration file when cross subdomain cookies are required.

Deletes all of the cookies associated with authentication

clear_auth_cookie() 
since 2.5

Generate authentication cookie contents

generate_auth_cookie(integer $user_id, integer $expiration, $scheme = 'auth') : string
since 2.5
uses Calls 'auth_cookie' hook on $cookie contents, User ID and expiration of cookie.

Parameters

$user_id

integer

User ID

$expiration

integer

Cookie expiration in seconds

$scheme

Returns

stringAuthentication cookie contents

Populate variables with information about the currently logged in user

get_current_user() : boolean | null

Will set the current user, if the current user is not set. The current user will be set to the logged in person. If no user is logged in, then it will set the current user to 0, which is invalid and won't have any permissions.

since 0.71
uses Checks if the current user is set
uses Retrieves current logged in user.

Returns

booleannullFalse on XMLRPC Request and invalid auth cookie. Null when current user set

Sets the authentication cookies based User ID

set_auth_cookie(integer $user_id, integer $expiration = 0, integer $expire = 0, integer $scheme = 'auth') 

The $remember parameter increases the time that the cookie will be kept. The default the cookie is kept without remembering is two days. When $remember is set, the cookies will be kept for 14 days or two weeks.

since 2.5

Parameters

$user_id

integer

User ID

$expiration

integer

the UNIX time after which the cookie's authentication token is no longer valid

$expire

integer

the UNIX time at which the cookie expires

$scheme

integer

name of the

Changes the current user by ID or name

set_current_user($user_id) : \BP_User

Set $id to null and specify a name if you do not know a user's ID

Some WordPress functionality is based on the current user and not based on the signed in user. Therefore, it opens the ability to edit and perform actions on users who aren't signed in.

since 2.0.4
uses Calls 'set_current_user' hook after setting the current user.

Parameters

$user_id

Returns

\BP_UserCurrent user User object

Validates authentication cookie

validate_auth_cookie(string $cookie = null, $scheme = 'auth') : boolean | integer

The checks include making sure that the authentication cookie is set and pulling in the contents (if $cookie is not used).

Makes sure the cookie is not expired. Verifies the hash in cookie is what is should be and compares the two.

since 2.5

Parameters

$cookie

string

Optional. If used, will validate contents instead of cookie's

$scheme

Returns

booleanintegerFalse if invalid cookie, User ID if valid.

 Properties

 

$cookies

$cookies 

Default

 

$current

$current 

Default

0
 

$db

$db 

Default

 

$users

$users 

Default