1<?php
2/**
3 * Deprecated pluggable functions from past WordPress versions. You shouldn't use these
4 * functions and look for the alternatives instead. The functions will be removed in a
5 * later version.
6 *
7 * Deprecated warnings are also thrown if one of these functions is being defined by a plugin.
8 *
9 * @package WordPress
10 * @subpackage Deprecated
11 * @see pluggable.php
12 */
13
14/*
15 * Deprecated functions come here to die.
16 */
17
18if ( !function_exists('set_current_user') ) :
19/**
20 * Changes the current user by ID or name.
21 *
22 * Set $id to null and specify a name if you do not know a user's ID.
23 *
24 * @since 2.0.1
25 * @deprecated 3.0.0 Use wp_set_current_user()
26 * @see wp_set_current_user()
27 *
28 * @param int|null $id User ID.
29 * @param string $name Optional. The user's username
30 * @return WP_User returns wp_set_current_user()
31 */
32function set_current_user($id, $name = '') {
33 _deprecated_function( __FUNCTION__, '3.0.0', 'wp_set_current_user()' );
34 return wp_set_current_user($id, $name);
35}
36endif;
37
38if ( !function_exists('get_currentuserinfo') ) :
39/**
40 * Populate global variables with information about the currently logged in user.
41 *
42 * @since 0.71
43 * @deprecated 4.5.0 Use wp_get_current_user()
44 * @see wp_get_current_user()
45 *
46 * @return bool|WP_User False on XMLRPC Request and invalid auth cookie, WP_User instance otherwise.
47 */
48function get_currentuserinfo() {
49 _deprecated_function( __FUNCTION__, '4.5.0', 'wp_get_current_user()' );
50
51 return _wp_get_current_user();
52}
53endif;
54
55if ( !function_exists('get_userdatabylogin') ) :
56/**
57 * Retrieve user info by login name.
58 *
59 * @since 0.71
60 * @deprecated 3.3.0 Use get_user_by()
61 * @see get_user_by()
62 *
63 * @param string $user_login User's username
64 * @return bool|object False on failure, User DB row object
65 */
66function get_userdatabylogin($user_login) {
67 _deprecated_function( __FUNCTION__, '3.3.0', "get_user_by('login')" );
68 return get_user_by('login', $user_login);
69}
70endif;
71
72if ( !function_exists('get_user_by_email') ) :
73/**
74 * Retrieve user info by email.
75 *
76 * @since 2.5.0
77 * @deprecated 3.3.0 Use get_user_by()
78 * @see get_user_by()
79 *
80 * @param string $email User's email address
81 * @return bool|object False on failure, User DB row object
82 */
83function get_user_by_email($email) {
84 _deprecated_function( __FUNCTION__, '3.3.0', "get_user_by('email')" );
85 return get_user_by('email', $email);
86}
87endif;
88
89if ( !function_exists('wp_setcookie') ) :
90/**
91 * Sets a cookie for a user who just logged in. This function is deprecated.
92 *
93 * @since 1.5.0
94 * @deprecated 2.5.0 Use wp_set_auth_cookie()
95 * @see wp_set_auth_cookie()
96 *
97 * @param string $username The user's username
98 * @param string $password Optional. The user's password
99 * @param bool $already_md5 Optional. Whether the password has already been through MD5
100 * @param string $home Optional. Will be used instead of COOKIEPATH if set
101 * @param string $siteurl Optional. Will be used instead of SITECOOKIEPATH if set
102 * @param bool $remember Optional. Remember that the user is logged in
103 */
104function wp_setcookie(
105 $username,
106 #[\SensitiveParameter]
107 $password = '',
108 $already_md5 = false,
109 $home = '',
110 $siteurl = '',
111 $remember = false
112) {
113 _deprecated_function( __FUNCTION__, '2.5.0', 'wp_set_auth_cookie()' );
114 $user = get_user_by('login', $username);
115 wp_set_auth_cookie($user->ID, $remember);
116}
117else :
118 _deprecated_function( 'wp_setcookie', '2.5.0', 'wp_set_auth_cookie()' );
119endif;
120
121if ( !function_exists('wp_clearcookie') ) :
122/**
123 * Clears the authentication cookie, logging the user out. This function is deprecated.
124 *
125 * @since 1.5.0
126 * @deprecated 2.5.0 Use wp_clear_auth_cookie()
127 * @see wp_clear_auth_cookie()
128 */
129function wp_clearcookie() {
130 _deprecated_function( __FUNCTION__, '2.5.0', 'wp_clear_auth_cookie()' );
131 wp_clear_auth_cookie();
132}
133else :
134 _deprecated_function( 'wp_clearcookie', '2.5.0', 'wp_clear_auth_cookie()' );
135endif;
136
137if ( !function_exists('wp_get_cookie_login') ):
138/**
139 * Gets the user cookie login. This function is deprecated.
140 *
141 * This function is deprecated and should no longer be extended as it won't be
142 * used anywhere in WordPress. Also, plugins shouldn't use it either.
143 *
144 * @since 2.0.3
145 * @deprecated 2.5.0
146 *
147 * @return bool Always returns false
148 */
149function wp_get_cookie_login() {
150 _deprecated_function( __FUNCTION__, '2.5.0' );
151 return false;
152}
153else :
154 _deprecated_function( 'wp_get_cookie_login', '2.5.0' );
155endif;
156
157if ( !function_exists('wp_login') ) :
158/**
159 * Checks a users login information and logs them in if it checks out. This function is deprecated.
160 *
161 * Use the global $error to get the reason why the login failed. If the username
162 * is blank, no error will be set, so assume blank username on that case.
163 *
164 * Plugins extending this function should also provide the global $error and set
165 * what the error is, so that those checking the global for why there was a
166 * failure can utilize it later.
167 *
168 * @since 1.2.2
169 * @deprecated 2.5.0 Use wp_signon()
170 * @see wp_signon()
171 *
172 * @global string $error Error when false is returned
173 *
174 * @param string $username User's username
175 * @param string $password User's password
176 * @param string $deprecated Not used
177 * @return bool True on successful check, false on login failure.
178 */
179function wp_login(
180 $username,
181 #[\SensitiveParameter]
182 $password,
183 $deprecated = ''
184) {
185 _deprecated_function( __FUNCTION__, '2.5.0', 'wp_signon()' );
186 global $error;
187
188 $user = wp_authenticate($username, $password);
189
190 if ( ! is_wp_error($user) )
191 return true;
192
193 $error = $user->get_error_message();
194 return false;
195}
196else :
197 _deprecated_function( 'wp_login', '2.5.0', 'wp_signon()' );
198endif;
199
200/**
201 * WordPress AtomPub API implementation.
202 *
203 * Originally stored in wp-app.php, and later wp-includes/class-wp-atom-server.php.
204 * It is kept here in case a plugin directly referred to the class.
205 *
206 * @since 2.2.0
207 * @deprecated 3.5.0
208 *
209 * @link https://wordpress.org/plugins/atom-publishing-protocol/
210 */
211if ( ! class_exists( 'wp_atom_server', false ) ) {
212 class wp_atom_server {
213 public function __call( $name, $arguments ) {
214 _deprecated_function( __CLASS__ . '::' . $name, '3.5.0', 'the Atom Publishing Protocol plugin' );
215 }
216
217 public static function __callStatic( $name, $arguments ) {
218 _deprecated_function( __CLASS__ . '::' . $name, '3.5.0', 'the Atom Publishing Protocol plugin' );
219 }
220 }
221}
222