PHPXRef 0.7.1 : WordPress : Detail view of pluggable-deprecated.php

[Source view] [Print] [Project Stats]

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:	208 lines (6 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

wp_atom_server:: (2 methods):
__call()
__callStatic()

Defines 2 functions

  set_current_user()
  get_currentuserinfo()
  get_userdatabylogin()
  get_user_by_email()
  wp_setcookie()
  wp_clearcookie()
  wp_get_cookie_login()
  wp_login()

Class: wp_atom_server - X-Ref

WordPress AtomPub API implementation.

Originally stored in wp-app.php, and later wp-includes/class-wp-atom-server.php.
It is kept here in case a plugin directly referred to the class.

__call( $name, $arguments ) X-Ref

No description

__callStatic( $name, $arguments ) X-Ref

No description

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.

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

get_currentuserinfo() X-Ref

Populate global variables with information about the currently logged in user.

return: bool|WP_User False on XMLRPC Request and invalid auth cookie, WP_User instance otherwise.
since: 0.71

get_userdatabylogin($user_login) X-Ref

Retrieve user info by login name.

return: bool|object False on failure, User DB row object
param: string $user_login User's username
since: 0.71

get_user_by_email($email) X-Ref

Retrieve user info by email.

return: bool|object False on failure, User DB row object
param: string $email User's email address
since: 2.5.0

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
since: 1.5.0

wp_clearcookie() X-Ref

Clears the authentication cookie, logging the user out. This function is deprecated.

since: 1.5.0

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
since: 2.0.3

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.

return: bool True on successful check, false on login failure.
param: string $username User's username
param: string $password User's password
param: string $deprecated Not used
since: 1.2.2

PHP Cross Reference of WordPress

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

Defines 1 class

Defines 2 functions