[ Index ]

PHP Cross Reference of WordPress (Trunk)

title

Body

[close]

/wp-includes/ -> pluggable-deprecated.php (summary)

Deprecated pluggable functions from past WordPress versions. You shouldn't use these functions and look for the alternatives instead. The functions will be removed in a later version. Deprecated warnings are also thrown if one of these functions is being defined by a plugin.

File Size: 136 lines (4 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 0 files

Defines 5 functions

  set_current_user()
  wp_setcookie()
  wp_clearcookie()
  wp_get_cookie_login()
  wp_login()

Functions
Functions that are not part of a class:

set_current_user($id, $name = '')   X-Ref
Changes the current user by ID or name.

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

param: int|null $id User ID.
param: string $name Optional. The user's username
return: object returns wp_set_current_user()

wp_setcookie($username, $password = '', $already_md5 = false, $home = '', $siteurl = '', $remember = false)   X-Ref
Sets a cookie for a user who just logged in. This function is deprecated.

param: string $username The user's username
param: string $password Optional. The user's password
param: bool $already_md5 Optional. Whether the password has already been through MD5
param: string $home Optional. Will be used instead of COOKIEPATH if set
param: string $siteurl Optional. Will be used instead of SITECOOKIEPATH if set
param: bool $remember Optional. Remember that the user is logged in

wp_clearcookie()   X-Ref
Clears the authentication cookie, logging the user out. This function is deprecated.


wp_get_cookie_login()   X-Ref
Gets the user cookie login. This function is deprecated.

This function is deprecated and should no longer be extended as it won't be
used anywhere in WordPress. Also, plugins shouldn't use it either.

return: bool Always returns false

wp_login($username, $password, $deprecated = '')   X-Ref
Checks a users login information and logs them in if it checks out. This function is deprecated.

Use the global $error to get the reason why the login failed. If the username
is blank, no error will be set, so assume blank username on that case.

Plugins extending this function should also provide the global $error and set
what the error is, so that those checking the global for why there was a
failure can utilize it later.

param: string $username User's username
param: string $password User's password
param: bool $deprecated Not used
return: bool False on login failure, true on successful check



Generated: Fri Jul 30 03:37:10 2010 Cross-referenced by PHPXref 0.7