WordPress.org

Make WordPress Core

Ticket #6229: pluggable.php

File pluggable.php, 43.5 KB (added by link2caro, 6 years ago)
Line 
1<?php
2/**
3 * These functions can be replaced via plugins. They are loaded after
4 * plugins are loaded.
5 *
6 * @package WordPress
7 */
8
9if ( !function_exists('set_current_user') ) :
10/**
11 * set_current_user() - Populates global user information for any user
12 *
13 * Set $id to null and specify a name if you do not know a user's ID
14 *
15 * @since 2.0.1
16 * @see wp_set_current_user() An alias of wp_set_current_user()
17 *
18 * @param int|null $id User ID.
19 * @param string $name Optional. The user's username
20 * @return object returns wp_set_current_user()
21 */
22function set_current_user($id, $name = '') {
23        return wp_set_current_user($id, $name);
24}
25endif;
26
27if ( !function_exists('wp_set_current_user') ) :
28/**
29 * wp_set_current_user() - Changes the current user by ID or name
30 *
31 * Set $id to null and specify a name if you do not know a user's ID
32 *
33 * Some WordPress functionality is based on the current user and
34 * not based on the signed in user. Therefore, it opens the ability
35 * to edit and perform actions on users who aren't signed in.
36 *
37 * @since 2.0.4
38 * @global object $current_user The current user object which holds the user data.
39 * @uses do_action() Calls 'set_current_user' hook after setting the current user.
40 *
41 * @param int $id User ID
42 * @param string $name User's username
43 * @return WP_User Current user User object
44 */
45function wp_set_current_user($id, $name = '') {
46        global $current_user;
47
48        if ( isset($current_user) && ($id == $current_user->ID) )
49                return $current_user;
50
51        $current_user = new WP_User($id, $name);
52
53        setup_userdata($current_user->ID);
54
55        do_action('set_current_user');
56
57        return $current_user;
58}
59endif;
60
61if ( !function_exists('wp_get_current_user') ) :
62/**
63 * wp_get_current_user() - Retrieve the current user object
64 *
65 * @since 2.0.4
66 *
67 * @return WP_User Current user WP_User object
68 */
69function wp_get_current_user() {
70        global $current_user;
71
72        get_currentuserinfo();
73
74        return $current_user;
75}
76endif;
77
78if ( !function_exists('get_currentuserinfo') ) :
79/**
80 * get_currentuserinfo() - Populate global variables with information about the currently logged in user
81 *
82 * Will set the current user, if the current user is not set. The current
83 * user will be set to the logged in person. If no user is logged in, then
84 * it will set the current user to 0, which is invalid and won't have any
85 * permissions.
86 *
87 * @since 0.71
88 * @uses $current_user Checks if the current user is set
89 * @uses wp_validate_auth_cookie() Retrieves current logged in user.
90 *
91 * @return bool|null False on XMLRPC Request and invalid auth cookie. Null when current user set
92 */
93function get_currentuserinfo() {
94        global $current_user;
95
96        if ( defined('XMLRPC_REQUEST') && XMLRPC_REQUEST )
97                return false;
98
99        if ( ! empty($current_user) )
100                return;
101
102        if ( ! $user = wp_validate_auth_cookie() ) {
103                wp_set_current_user(0);
104                return false;
105        }
106
107        wp_set_current_user($user);
108}
109endif;
110
111if ( !function_exists('get_userdata') ) :
112/**
113 * get_userdata() - Retrieve user info by user ID
114 *
115 * @since 0.71
116 *
117 * @param int $user_id User ID
118 * @return bool|object False on failure, User DB row object
119 */
120function get_userdata( $user_id ) {
121        global $wpdb;
122
123        $user_id = absint($user_id);
124        if ( $user_id == 0 )
125                return false;
126
127        $user = wp_cache_get($user_id, 'users');
128
129        if ( $user )
130                return $user;
131
132        if ( !$user = $wpdb->get_row($wpdb->prepare("SELECT * FROM $wpdb->users WHERE ID = %d LIMIT 1", $user_id)) )
133                return false;
134
135        _fill_user($user);
136
137        return $user;
138}
139endif;
140
141if ( !function_exists('update_user_cache') ) :
142/**
143 * update_user_cache() - Updates a users cache when overridden by a plugin
144 *
145 * Core function does nothing.
146 *
147 * @since 1.5
148 *
149 * @return bool Only returns true
150 */
151function update_user_cache() {
152        return true;
153}
154endif;
155
156if ( !function_exists('get_userdatabylogin') ) :
157/**
158 * get_userdatabylogin() - Retrieve user info by login name
159 *
160 * @since 0.71
161 *
162 * @param string $user_login User's username
163 * @return bool|object False on failure, User DB row object
164 */
165function get_userdatabylogin($user_login) {
166        global $wpdb;
167        $user_login = sanitize_user( $user_login );
168
169        if ( empty( $user_login ) )
170                return false;
171
172        $user_id = wp_cache_get($user_login, 'userlogins');
173
174        $user = false;
175        if ( false !== $user_id )
176                $user = wp_cache_get($user_id, 'users');
177
178        if ( false !== $user )
179                return $user;
180
181        if ( !$user = $wpdb->get_row($wpdb->prepare("SELECT * FROM $wpdb->users WHERE user_login = %s", $user_login)) )
182                return false;
183
184        _fill_user($user);
185
186        return $user;
187}
188endif;
189
190if ( !function_exists('get_user_by_email') ) :
191/**
192 * get_user_by_email() - Retrieve user info by email
193 *
194 * @since 2.5
195 *
196 * @param string $email User's email address
197 * @return bool|object False on failure, User DB row object
198 */
199function get_user_by_email($email) {
200        global $wpdb;
201
202        $user_id = wp_cache_get($email, 'useremail');
203
204        $user = false;
205        if ( false !== $user_id )
206                $user = wp_cache_get($user_id, 'users');
207
208        if ( false !== $user )
209                return $user;
210
211        if ( !$user = $wpdb->get_row($wpdb->prepare("SELECT * FROM $wpdb->users WHERE user_email = %s", $email)) )
212                return false;
213
214        _fill_user($user);
215
216        return $user;
217}
218endif;
219
220if ( !function_exists( 'wp_mail' ) ) :
221/**
222 * wp_mail() - Function to send mail, similar to PHP's mail
223 *
224 * A true return value does not automatically mean that the
225 * user received the email successfully. It just only means
226 * that the method used was able to process the request
227 * without any errors.
228 *
229 * Using the two 'wp_mail_from' and 'wp_mail_from_name' hooks
230 * allow from creating a from address like 'Name <email@address.com>'
231 * when both are set. If just 'wp_mail_from' is set, then just
232 * the email address will be used with no name.
233 *
234 * The default content type is 'text/plain' which does not
235 * allow using HTML. However, you can set the content type
236 * of the email by using the 'wp_mail_content_type' filter.
237 *
238 * The default charset is based on the charset used on the
239 * blog. The charset can be set using the 'wp_mail_charset'
240 * filter.
241 *
242 * @since 1.2.1
243 * @uses apply_filters() Calls 'wp_mail' hook on an array of all of the parameters.
244 * @uses apply_filters() Calls 'wp_mail_from' hook to get the from email address.
245 * @uses apply_filters() Calls 'wp_mail_from_name' hook to get the from address name.
246 * @uses apply_filters() Calls 'wp_mail_content_type' hook to get the email content type.
247 * @uses apply_filters() Calls 'wp_mail_charset' hook to get the email charset
248 * @uses do_action_ref_array() Calls 'phpmailer_init' hook on the reference to
249 *              phpmailer object.
250 * @uses PHPMailer
251 * @
252 *
253 * @param string $to Email address to send message
254 * @param string $subject Email subject
255 * @param string $message Message contents
256 * @param string|array $headers Optional. Additional headers.
257 * @return bool Whether the email contents were sent successfully.
258 */
259function wp_mail( $to, $subject, $message, $headers = '' ) {
260        // Compact the input, apply the filters, and extract them back out
261        extract( apply_filters( 'wp_mail', compact( 'to', 'subject', 'message', 'headers' ) ) );
262
263        global $phpmailer;
264
265        // (Re)create it, if it's gone missing
266        if ( !is_object( $phpmailer ) || !is_a( $phpmailer, 'PHPMailer' ) ) {
267                require_once ABSPATH . WPINC . '/class-phpmailer.php';
268                require_once ABSPATH . WPINC . '/class-smtp.php';
269                $phpmailer = new PHPMailer();
270        }
271
272        // Headers
273        if ( empty( $headers ) ) {
274                $headers = array();
275        } elseif ( !is_array( $headers ) ) {
276                // Explode the headers out, so this function can take both
277                // string headers and an array of headers.
278                $tempheaders = (array) explode( "\n", $headers );
279                $headers = array();
280
281                // If it's actually got contents
282                if ( !empty( $tempheaders ) ) {
283                        // Iterate through the raw headers
284                        foreach ( $tempheaders as $header ) {
285                                if ( strpos($header, ':') === false )
286                                        continue;
287                                // Explode them out
288                                list( $name, $content ) = explode( ':', trim( $header ), 2 );
289
290                                // Cleanup crew
291                                $name = trim( $name );
292                                $content = trim( $content );
293
294                                // Mainly for legacy -- process a From: header if it's there
295                                if ( 'from' == strtolower($name) ) {
296                                        if ( strpos($content, '<' ) !== false ) {
297                                                // So... making my life hard again?
298                                                $from_name = substr( $content, 0, strpos( $content, '<' ) - 1 );
299                                                $from_name = str_replace( '"', '', $from_name );
300                                                $from_name = trim( $from_name );
301
302                                                $from_email = substr( $content, strpos( $content, '<' ) + 1 );
303                                                $from_email = str_replace( '>', '', $from_email );
304                                                $from_email = trim( $from_email );
305                                        } else {
306                                                $from_name = trim( $content );
307                                        }
308                                } elseif ( 'content-type' == strtolower($name) ) {
309                                        if ( strpos( $content,';' ) !== false ) {
310                                                list( $type, $charset ) = explode( ';', $content );
311                                                $content_type = trim( $type );
312                                                $charset = trim( str_replace( array( 'charset=', '"' ), '', $charset ) );
313                                        } else {
314                                                $content_type = trim( $content );
315                                        }
316                                } else {
317                                        // Add it to our grand headers array
318                                        $headers[trim( $name )] = trim( $content );
319                                }
320                        }
321                }
322        }
323
324        // Empty out the values that may be set
325        $phpmailer->ClearAddresses();
326        $phpmailer->ClearAllRecipients();
327        $phpmailer->ClearAttachments();
328        $phpmailer->ClearBCCs();
329        $phpmailer->ClearCCs();
330        $phpmailer->ClearCustomHeaders();
331        $phpmailer->ClearReplyTos();
332
333        // From email and name
334        // If we don't have a name from the input headers
335        if ( !isset( $from_name ) ) {
336                $from_name = 'WordPress';
337        }
338
339        // If we don't have an email from the input headers
340        if ( !isset( $from_email ) ) {
341                // Get the site domain and get rid of www.
342                $sitename = strtolower( $_SERVER['SERVER_NAME'] );
343                if ( substr( $sitename, 0, 4 ) == 'www.' ) {
344                        $sitename = substr( $sitename, 4 );
345                }
346
347                $from_email = 'wordpress@' . $sitename;
348        }
349
350        // Set the from name and email
351        $phpmailer->From = apply_filters( 'wp_mail_from', $from_email );
352        $phpmailer->FromName = apply_filters( 'wp_mail_from_name', $from_name );
353
354        // Set destination address
355        $phpmailer->AddAddress( $to );
356
357        // Set mail's subject and body
358        $phpmailer->Subject = $subject;
359        $phpmailer->Body = $message;
360
361        // Set to use PHP's mail()
362        $phpmailer->IsMail();
363
364        // Set Content-Type and charset
365        // If we don't have a content-type from the input headers
366        if ( !isset( $content_type ) ) {
367                $content_type = 'text/plain';
368        }
369
370        $content_type = apply_filters( 'wp_mail_content_type', $content_type );
371
372        // Set whether it's plaintext or not, depending on $content_type
373        if ( $content_type == 'text/html' ) {
374                $phpmailer->IsHTML( true );
375        } else {
376                $phpmailer->IsHTML( false );
377        }
378
379        // If we don't have a charset from the input headers
380        if ( !isset( $charset ) ) {
381                $charset = get_bloginfo( 'charset' );
382        }
383
384        // Set the content-type and charset
385        $phpmailer->CharSet = apply_filters( 'wp_mail_charset', $charset );
386
387        // Set custom headers
388        if ( !empty( $headers ) ) {
389                foreach ( $headers as $name => $content ) {
390                        $phpmailer->AddCustomHeader( sprintf( '%1$s: %2$s', $name, $content ) );
391                }
392        }
393
394        do_action_ref_array( 'phpmailer_init', array( &$phpmailer ) );
395
396        // Send!
397        $result = @$phpmailer->Send();
398
399        return $result;
400}
401endif;
402
403/**
404 * wp_authenticate() - Checks a user's login information and logs them in if it checks out
405 * @since 2.5
406 *
407 * @param string $username User's username
408 * @param string $password User's password
409 * @return WP_Error|WP_User WP_User object if login successful, otherwise WP_Error object.
410 */
411if ( !function_exists('wp_authenticate') ) :
412function wp_authenticate($username, $password) {
413        $username = sanitize_user($username);
414
415        if ( '' == $username )
416                return new WP_Error('empty_username', __('<strong>ERROR</strong>: The username field is empty.'));
417
418        if ( '' == $password )
419                return new WP_Error('empty_password', __('<strong>ERROR</strong>: The password field is empty.'));
420
421        $user = get_userdatabylogin($username);
422
423        if ( !$user || ($user->user_login != $username) ) {
424                do_action( 'wp_login_failed', $username );
425                return new WP_Error('invalid_username', __('<strong>ERROR</strong>: Invalid username.'));
426        }
427
428        $user = apply_filters('wp_authenticate_user', $user, $password);
429        if ( is_wp_error($user) ) {
430                do_action( 'wp_login_failed', $username );
431                return $user;
432        }
433
434        if ( !wp_check_password($password, $user->user_pass) ) {
435                do_action( 'wp_login_failed', $username );
436                return new WP_Error('incorrect_password', __('<strong>ERROR</strong>: Incorrect password.'));
437        }
438
439        // If using old md5 password, rehash.
440        if ( strlen($user->user_pass) <= 32 )
441                wp_set_password($password, $user->ID);
442
443        return new WP_User($user->ID);
444}
445endif;
446
447/**
448 * wp_logout() - Log the current user out
449 * @since 2.5
450 *
451 */
452if ( !function_exists('wp_logout') ) :
453function wp_logout() {
454        wp_clear_auth_cookie();
455        do_action('wp_logout');
456}
457endif;
458
459if ( !function_exists('wp_validate_auth_cookie') ) :
460/**
461 * wp_validate_auth_cookie() - Validates authentication cookie
462 *
463 * The checks include making sure that the authentication cookie
464 * is set and pulling in the contents (if $cookie is not used).
465 *
466 * Makes sure the cookie is not expired. Verifies the hash in
467 * cookie is what is should be and compares the two.
468 *
469 * @since 2.5
470 *
471 * @param string $cookie Optional. If used, will validate contents instead of cookie's
472 * @return bool|int False if invalid cookie, User ID if valid.
473 */
474function wp_validate_auth_cookie($cookie = '') {
475        if ( empty($cookie) ) {
476                if ( empty($_COOKIE[AUTH_COOKIE]) )
477                        return false;
478                $cookie = $_COOKIE[AUTH_COOKIE];
479        }
480
481        list($username, $expiration, $hmac) = explode('|', $cookie);
482
483        $expired = $expiration;
484
485        // Allow a grace period for POST and AJAX requests
486        if ( defined('DOING_AJAX') || 'POST' == $_SERVER['REQUEST_METHOD'] )
487                $expired += 3600;
488
489        if ( $expired < time() )
490                return false;
491
492        $key = wp_hash($username . $expiration);
493        $hash = hash_hmac('md5', $username . $expiration, $key);
494
495        if ( $hmac != $hash )
496                return false;
497
498        $user = get_userdatabylogin($username);
499        if ( ! $user )
500                return false;
501
502        return $user->ID;
503}
504endif;
505
506if ( !function_exists('wp_generate_auth_cookie') ) :
507/**
508 * wp_generate_auth_cookie() - Generate authentication cookie contents
509 *
510 * @since 2.5
511 * @uses apply_filters() Calls 'auth_cookie' hook on $cookie contents, User ID
512 *              and expiration of cookie.
513 *
514 * @param int $user_id User ID
515 * @param int $expiration Cookie expiration in seconds
516 * @return string Authentication cookie contents
517 */
518function wp_generate_auth_cookie($user_id, $expiration) {
519        $user = get_userdata($user_id);
520
521        $key = wp_hash($user->user_login . $expiration);
522        $hash = hash_hmac('md5', $user->user_login . $expiration, $key);
523
524        $cookie = $user->user_login . '|' . $expiration . '|' . $hash;
525
526        return apply_filters('auth_cookie', $cookie, $user_id, $expiration);
527}
528endif;
529
530if ( !function_exists('wp_set_auth_cookie') ) :
531/**
532 * wp_set_auth_cookie() - Sets the authentication cookies based User ID
533 *
534 * The $remember parameter increases the time that the cookie will
535 * be kept. The default the cookie is kept without remembering is
536 * two days. When $remember is set, the cookies will be kept for
537 * 14 days or two weeks.
538 *
539 * @since 2.5
540 *
541 * @param int $user_id User ID
542 * @param bool $remember Whether to remember the user or not
543 */
544function wp_set_auth_cookie($user_id, $remember = false) {
545        if ( $remember ) {
546                $expiration = $expire = time() + 1209600;
547        } else {
548                $expiration = time() + 172800;
549                $expire = 0;
550        }
551
552        $cookie = wp_generate_auth_cookie($user_id, $expiration);
553
554        do_action('set_auth_cookie', $cookie, $expire);
555
556        setcookie(AUTH_COOKIE, $cookie, $expire, COOKIEPATH, COOKIE_DOMAIN);
557        if ( COOKIEPATH != SITECOOKIEPATH )
558                setcookie(AUTH_COOKIE, $cookie, $expire, SITECOOKIEPATH, COOKIE_DOMAIN);
559}
560endif;
561
562if ( !function_exists('wp_clear_auth_cookie') ) :
563/**
564 * wp_clear_auth_cookie() - Deletes all of the cookies associated with authentication
565 *
566 * @since 2.5
567 */
568function wp_clear_auth_cookie() {
569        setcookie(AUTH_COOKIE, ' ', time() - 31536000, COOKIEPATH, COOKIE_DOMAIN);
570        setcookie(AUTH_COOKIE, ' ', time() - 31536000, SITECOOKIEPATH, COOKIE_DOMAIN);
571
572        // Old cookies
573        setcookie(USER_COOKIE, ' ', time() - 31536000, COOKIEPATH, COOKIE_DOMAIN);
574        setcookie(PASS_COOKIE, ' ', time() - 31536000, COOKIEPATH, COOKIE_DOMAIN);
575        setcookie(USER_COOKIE, ' ', time() - 31536000, SITECOOKIEPATH, COOKIE_DOMAIN);
576        setcookie(PASS_COOKIE, ' ', time() - 31536000, SITECOOKIEPATH, COOKIE_DOMAIN);
577}
578endif;
579
580if ( !function_exists('is_user_logged_in') ) :
581/**
582 * is_user_logged_in() - Checks if the current visitor is a logged in user
583 *
584 * @since 2.0.0
585 *
586 * @return bool True if user is logged in, false if not logged in.
587 */
588function is_user_logged_in() {
589        $user = wp_get_current_user();
590
591        if ( $user->id == 0 )
592                return false;
593
594        return true;
595}
596endif;
597
598if ( !function_exists('auth_redirect') ) :
599/**
600 * auth_redirect() - Checks if a user is logged in, if not it redirects them to the login page
601 *
602 * @since 1.5
603 */
604function auth_redirect() {
605        // Checks if a user is logged in, if not redirects them to the login page
606        if ( (!empty($_COOKIE[AUTH_COOKIE]) &&
607                                !wp_validate_auth_cookie($_COOKIE[AUTH_COOKIE])) ||
608                        (empty($_COOKIE[AUTH_COOKIE])) ) {
609                nocache_headers();
610
611                wp_redirect(get_option('siteurl') . '/wp-login.php?redirect_to=' . urlencode($_SERVER['REQUEST_URI']));
612                exit();
613        }
614}
615endif;
616
617if ( !function_exists('check_admin_referer') ) :
618/**
619 * check_admin_referer() - Makes sure that a user was referred from another admin page, to avoid security exploits
620 *
621 * @since 1.2.0
622 * @uses do_action() Calls 'check_admin_referer' on $action.
623 *
624 * @param string $action Action nonce
625 * @param string $query_arg where to look for nonce in $_REQUEST (since 2.5)
626 */
627function check_admin_referer($action = -1, $query_arg = '_wpnonce' ) {
628        $adminurl = strtolower(get_option('siteurl')).'/wp-admin';
629        $referer = strtolower(wp_get_referer());
630        if ( !wp_verify_nonce($_REQUEST[$query_arg], $action) &&
631                !(-1 == $action && strpos($referer, $adminurl) !== false)) {
632                wp_nonce_ays($action);
633                die();
634        }
635        do_action('check_admin_referer', $action);
636}endif;
637
638if ( !function_exists('check_ajax_referer') ) :
639/**
640 * check_ajax_referer() - Verifies the AJAX request to prevent processing requests external of the blog.
641 *
642 * @since 2.0.4
643 *
644 * @param string $action Action nonce
645 * @param string $query_arg where to look for nonce in $_REQUEST (since 2.5)
646 */
647function check_ajax_referer( $action = -1, $query_arg = false ) {
648        if ( $query_arg )
649                $nonce = $_REQUEST[$query_arg];
650        else
651                $nonce = $_REQUEST['_ajax_nonce'] ? $_REQUEST['_ajax_nonce'] : $_REQUEST['_wpnonce'];
652
653        if ( !wp_verify_nonce( $nonce, $action ) )
654                die('-1');
655
656        do_action('check_ajax_referer');
657}
658endif;
659
660if ( !function_exists('wp_redirect') ) :
661/**
662 * wp_redirect() - Redirects to another page, with a workaround for the IIS Set-Cookie bug
663 *
664 * @link http://support.microsoft.com/kb/q176113/
665 * @since 1.5.1
666 * @uses apply_filters() Calls 'wp_redirect' hook on $location and $status.
667 *
668 * @param string $location The path to redirect to
669 * @param int $status Status code to use
670 * @return bool False if $location is not set
671 */
672function wp_redirect($location, $status = 302) {
673        global $is_IIS;
674
675        $location = apply_filters('wp_redirect', $location, $status);
676
677        if ( !$location ) // allows the wp_redirect filter to cancel a redirect
678                return false;
679
680        $location = wp_sanitize_redirect($location);
681
682        if ( $is_IIS ) {
683                header("Refresh: 0;url=$location");
684        } else {
685                if ( php_sapi_name() != 'cgi-fcgi' )
686                        status_header($status); // This causes problems on IIS and some FastCGI setups
687                header("Location: $location");
688        }
689}
690endif;
691
692if ( !function_exists('wp_sanitize_redirect') ) :
693/**
694 * wp_sanitize_redirect() - Sanitizes a URL for use in a redirect
695 *
696 * @since 2.3
697 *
698 * @return string redirect-sanitized URL
699 **/
700function wp_sanitize_redirect($location) {
701        $location = preg_replace('|[^a-z0-9-~+_.?#=&;,/:%]|i', '', $location);
702        $location = wp_kses_no_null($location);
703
704        // remove %0d and %0a from location
705        $strip = array('%0d', '%0a');
706        $found = true;
707        while($found) {
708                $found = false;
709                foreach($strip as $val) {
710                        while(strpos($location, $val) !== false) {
711                                $found = true;
712                                $location = str_replace($val, '', $location);
713                        }
714                }
715        }
716        return $location;
717}
718endif;
719
720if ( !function_exists('wp_safe_redirect') ) :
721/**
722 * wp_safe_redirect() - Performs a safe (local) redirect, using wp_redirect()
723 *
724 * Checks whether the $location is using an allowed host, if it has an absolute
725 * path. A plugin can therefore set or remove allowed host(s) to or from the list.
726 *
727 * If the host is not allowed, then the redirect is to wp-admin on the siteurl
728 * instead. This prevents malicious redirects which redirect to another host, but
729 * only used in a few places.
730 *
731 * @since 2.3
732 * @uses apply_filters() Calls 'allowed_redirect_hosts' on an array containing
733 *              WordPress host string and $location host string.
734 *
735 * @return void Does not return anything
736 **/
737function wp_safe_redirect($location, $status = 302) {
738
739        // Need to look at the URL the way it will end up in wp_redirect()
740        $location = wp_sanitize_redirect($location);
741
742        // browsers will assume 'http' is your protocol, and will obey a redirect to a URL starting with '//'
743        if ( substr($location, 0, 2) == '//' )
744                $location = 'http:' . $location;
745
746        $lp  = parse_url($location);
747        $wpp = parse_url(get_option('home'));
748
749        $allowed_hosts = (array) apply_filters('allowed_redirect_hosts', array($wpp['host']), isset($lp['host']) ? $lp['host'] : '');
750
751        if ( isset($lp['host']) && ( !in_array($lp['host'], $allowed_hosts) && $lp['host'] != strtolower($wpp['host'])) )
752                $location = get_option('siteurl') . '/wp-admin/';
753
754        wp_redirect($location, $status);
755}
756endif;
757
758if ( ! function_exists('wp_notify_postauthor') ) :
759/**
760 * wp_notify_postauthor() - Notify an author of a comment/trackback/pingback to one of their posts
761 *
762 * @since 1.0.0
763 *
764 * @param int $comment_id Comment ID
765 * @param string $comment_type Optional. The comment type either 'comment' (default), 'trackback', or 'pingback'
766 * @return bool False if user email does not exist. True on completion.
767 */
768function wp_notify_postauthor($comment_id, $comment_type='') {
769        $comment = get_comment($comment_id);
770        $post    = get_post($comment->comment_post_ID);
771        $user    = get_userdata( $post->post_author );
772
773        if ('' == $user->user_email) return false; // If there's no email to send the comment to
774
775        $comment_author_domain = @gethostbyaddr($comment->comment_author_IP);
776
777        $blogname = get_option('blogname');
778
779        if ( empty( $comment_type ) ) $comment_type = 'comment';
780
781        if ('comment' == $comment_type) {
782                $notify_message  = sprintf( __('New comment on your post #%1$s "%2$s"'), $comment->comment_post_ID, $post->post_title ) . "\r\n";
783                $notify_message .= sprintf( __('Author : %1$s (IP: %2$s , %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
784                $notify_message .= sprintf( __('E-mail : %s'), $comment->comment_author_email ) . "\r\n";
785                $notify_message .= sprintf( __('URL    : %s'), $comment->comment_author_url ) . "\r\n";
786                $notify_message .= sprintf( __('Whois  : http://ws.arin.net/cgi-bin/whois.pl?queryinput=%s'), $comment->comment_author_IP ) . "\r\n";
787                $notify_message .= __('Comment: ') . "\r\n" . $comment->comment_content . "\r\n\r\n";
788                $notify_message .= __('You can see all comments on this post here: ') . "\r\n";
789                $subject = sprintf( __('[%1$s] Comment: "%2$s"'), $blogname, $post->post_title );
790        } elseif ('trackback' == $comment_type) {
791                $notify_message  = sprintf( __('New trackback on your post #%1$s "%2$s"'), $comment->comment_post_ID, $post->post_title ) . "\r\n";
792                $notify_message .= sprintf( __('Website: %1$s (IP: %2$s , %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
793                $notify_message .= sprintf( __('URL    : %s'), $comment->comment_author_url ) . "\r\n";
794                $notify_message .= __('Excerpt: ') . "\r\n" . $comment->comment_content . "\r\n\r\n";
795                $notify_message .= __('You can see all trackbacks on this post here: ') . "\r\n";
796                $subject = sprintf( __('[%1$s] Trackback: "%2$s"'), $blogname, $post->post_title );
797        } elseif ('pingback' == $comment_type) {
798                $notify_message  = sprintf( __('New pingback on your post #%1$s "%2$s"'), $comment->comment_post_ID, $post->post_title ) . "\r\n";
799                $notify_message .= sprintf( __('Website: %1$s (IP: %2$s , %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
800                $notify_message .= sprintf( __('URL    : %s'), $comment->comment_author_url ) . "\r\n";
801                $notify_message .= __('Excerpt: ') . "\r\n" . sprintf('[...] %s [...]', $comment->comment_content ) . "\r\n\r\n";
802                $notify_message .= __('You can see all pingbacks on this post here: ') . "\r\n";
803                $subject = sprintf( __('[%1$s] Pingback: "%2$s"'), $blogname, $post->post_title );
804        }
805        $notify_message .= get_permalink($comment->comment_post_ID) . "#comments\r\n\r\n";
806        $notify_message .= sprintf( __('Delete it: %s'), get_option('siteurl')."/wp-admin/comment.php?action=cdc&c=$comment_id" ) . "\r\n";
807        $notify_message .= sprintf( __('Spam it: %s'), get_option('siteurl')."/wp-admin/comment.php?action=cdc&dt=spam&c=$comment_id" ) . "\r\n";
808
809        $wp_email = 'wordpress@' . preg_replace('#^www\.#', '', strtolower($_SERVER['SERVER_NAME']));
810
811        if ( '' == $comment->comment_author ) {
812                $from = "From: \"$blogname\" <$wp_email>";
813                if ( '' != $comment->comment_author_email )
814                        $reply_to = "Reply-To: $comment->comment_author_email";
815        } else {
816                $from = "From: \"$comment->comment_author\" <$wp_email>";
817                if ( '' != $comment->comment_author_email )
818                        $reply_to = "Reply-To: \"$comment->comment_author_email\" <$comment->comment_author_email>";
819        }
820
821        $message_headers = "$from\n"
822                . "Content-Type: text/plain; charset=\"" . get_option('blog_charset') . "\"\n";
823
824        if ( isset($reply_to) )
825                $message_headers .= $reply_to . "\n";
826
827        $notify_message = apply_filters('comment_notification_text', $notify_message, $comment_id);
828        $subject = apply_filters('comment_notification_subject', $subject, $comment_id);
829        $message_headers = apply_filters('comment_notification_headers', $message_headers, $comment_id);
830
831        @wp_mail($user->user_email, $subject, $notify_message, $message_headers);
832
833        return true;
834}
835endif;
836
837if ( !function_exists('wp_notify_moderator') ) :
838/**
839 * wp_notify_moderator() - Notifies the moderator of the blog about a new comment that is awaiting approval
840 *
841 * @since 1.0
842 * @uses $wpdb
843 *
844 * @param int $comment_id Comment ID
845 * @return bool Always returns true
846 */
847function wp_notify_moderator($comment_id) {
848        global $wpdb;
849
850        if( get_option( "moderation_notify" ) == 0 )
851                return true;
852
853        $comment = $wpdb->get_row($wpdb->prepare("SELECT * FROM $wpdb->comments WHERE comment_ID=%d LIMIT 1", $comment_id));
854        $post = $wpdb->get_row($wpdb->prepare("SELECT * FROM $wpdb->posts WHERE ID=%d LIMIT 1", $comment->comment_post_ID));
855
856        $comment_author_domain = @gethostbyaddr($comment->comment_author_IP);
857        $comments_waiting = $wpdb->get_var("SELECT count(comment_ID) FROM $wpdb->comments WHERE comment_approved = '0'");
858
859        switch ($comment->comment_type)
860        {
861                case 'trackback':
862                        $notify_message  = sprintf( __('A new trackback on the post #%1$s "%2$s" is waiting for your approval'), $post->ID, $post->post_title ) . "\r\n";
863                        $notify_message .= get_permalink($comment->comment_post_ID) . "\r\n\r\n";
864                        $notify_message .= sprintf( __('Website : %1$s (IP: %2$s , %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
865                        $notify_message .= sprintf( __('URL    : %s'), $comment->comment_author_url ) . "\r\n";
866                        $notify_message .= __('Trackback excerpt: ') . "\r\n" . $comment->comment_content . "\r\n\r\n";
867                        break;
868                case 'pingback':
869                        $notify_message  = sprintf( __('A new pingback on the post #%1$s "%2$s" is waiting for your approval'), $post->ID, $post->post_title ) . "\r\n";
870                        $notify_message .= get_permalink($comment->comment_post_ID) . "\r\n\r\n";
871                        $notify_message .= sprintf( __('Website : %1$s (IP: %2$s , %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
872                        $notify_message .= sprintf( __('URL    : %s'), $comment->comment_author_url ) . "\r\n";
873                        $notify_message .= __('Pingback excerpt: ') . "\r\n" . $comment->comment_content . "\r\n\r\n";
874                        break;
875                default: //Comments
876                        $notify_message  = sprintf( __('A new comment on the post #%1$s "%2$s" is waiting for your approval'), $post->ID, $post->post_title ) . "\r\n";
877                        $notify_message .= get_permalink($comment->comment_post_ID) . "\r\n\r\n";
878                        $notify_message .= sprintf( __('Author : %1$s (IP: %2$s , %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
879                        $notify_message .= sprintf( __('E-mail : %s'), $comment->comment_author_email ) . "\r\n";
880                        $notify_message .= sprintf( __('URL    : %s'), $comment->comment_author_url ) . "\r\n";
881                        $notify_message .= sprintf( __('Whois  : http://ws.arin.net/cgi-bin/whois.pl?queryinput=%s'), $comment->comment_author_IP ) . "\r\n";
882                        $notify_message .= __('Comment: ') . "\r\n" . $comment->comment_content . "\r\n\r\n";
883                        break;
884        }
885
886        $notify_message .= sprintf( __('Approve it: %s'),  get_option('siteurl')."/wp-admin/comment.php?action=mac&c=$comment_id" ) . "\r\n";
887        $notify_message .= sprintf( __('Delete it: %s'), get_option('siteurl')."/wp-admin/comment.php?action=cdc&c=$comment_id" ) . "\r\n";
888        $notify_message .= sprintf( __('Spam it: %s'), get_option('siteurl')."/wp-admin/comment.php?action=cdc&dt=spam&c=$comment_id" ) . "\r\n";
889
890        $strCommentsPending = sprintf( __ngettext('%s comment', '%s comments', $comments_waiting), $comments_waiting );
891        $notify_message .= sprintf( __('Currently %s are waiting for approval. Please visit the moderation panel:'), $strCommentsPending ) . "\r\n";
892        $notify_message .= get_option('siteurl') . "/wp-admin/moderation.php\r\n";
893
894        $subject = sprintf( __('[%1$s] Please moderate: "%2$s"'), get_option('blogname'), $post->post_title );
895        $admin_email = get_option('admin_email');
896
897        $notify_message = apply_filters('comment_moderation_text', $notify_message, $comment_id);
898        $subject = apply_filters('comment_moderation_subject', $subject, $comment_id);
899
900        @wp_mail($admin_email, $subject, $notify_message);
901
902        return true;
903}
904endif;
905
906if ( !function_exists('wp_new_user_notification') ) :
907/**
908 * wp_new_user_notification() - Notify the blog admin of a new user, normally via email
909 *
910 * @since 2.0
911 *
912 * @param int $user_id User ID
913 * @param string $plaintext_pass Optional. The user's plaintext password
914 */
915function wp_new_user_notification($user_id, $plaintext_pass = '') {
916        $user = new WP_User($user_id);
917
918        $user_login = stripslashes($user->user_login);
919        $user_email = stripslashes($user->user_email);
920
921        $message  = sprintf(__('New user registration on your blog %s:'), get_option('blogname')) . "\r\n\r\n";
922        $message .= sprintf(__('Username: %s'), $user_login) . "\r\n\r\n";
923        $message .= sprintf(__('E-mail: %s'), $user_email) . "\r\n";
924
925        @wp_mail(get_option('admin_email'), sprintf(__('[%s] New User Registration'), get_option('blogname')), $message);
926
927        if ( empty($plaintext_pass) )
928                return;
929
930        $message  = sprintf(__('Username: %s'), $user_login) . "\r\n";
931        $message .= sprintf(__('Password: %s'), $plaintext_pass) . "\r\n";
932        $message .= get_option('siteurl') . "/wp-login.php\r\n";
933
934        wp_mail($user_email, sprintf(__('[%s] Your username and password'), get_option('blogname')), $message);
935
936}
937endif;
938
939if ( !function_exists('wp_verify_nonce') ) :
940/**
941 * wp_verify_nonce() - Verify that correct nonce was used with time limit
942 *
943 * The user is given an amount of time to use the token, so therefore, since
944 * the UID and $action remain the same, the independent variable is the time.
945 *
946 * @since 2.0.4
947 *
948 * @param string $nonce Nonce that was used in the form to verify
949 * @param string|int $action Should give context to what is taking place and be the same when nonce was created.
950 * @return bool Whether the nonce check passed or failed.
951 */
952function wp_verify_nonce($nonce, $action = -1) {
953        $user = wp_get_current_user();
954        $uid = (int) $user->id;
955
956        $i = ceil(time() / 43200);
957
958        //Allow for expanding range, but only do one check if we can
959        if( substr(wp_hash($i . $action . $uid), -12, 10) == $nonce || substr(wp_hash(($i - 1) . $action . $uid), -12, 10) == $nonce )
960                return true;
961        return false;
962}
963endif;
964
965if ( !function_exists('wp_create_nonce') ) :
966/**
967 * wp_create_nonce() - Creates a random, one time use token
968 *
969 * @since 2.0.4
970 *
971 * @param string|int $action Scalar value to add context to the nonce.
972 * @return string The one use form token
973 */
974function wp_create_nonce($action = -1) {
975        $user = wp_get_current_user();
976        $uid = (int) $user->id;
977
978        $i = ceil(time() / 43200);
979
980        return substr(wp_hash($i . $action . $uid), -12, 10);
981}
982endif;
983
984if ( !function_exists('wp_salt') ) :
985/**
986 * wp_salt() - Get salt to add to hashes to help prevent attacks
987 *
988 * You can set the salt by defining two areas. One is in the database and
989 * the other is in your wp-config.php file. The database location is defined
990 * in the option named 'secret', but most likely will not need to be changed.
991 *
992 * The second, located in wp-config.php, is a constant named 'SECRET_KEY', but
993 * is not required. If the constant is not defined then the database constants
994 * will be used, since they are most likely given to be unique. However, given
995 * that the salt will be added to the password and can be seen, the constant
996 * is recommended to be set manually.
997 *
998 * <code>
999 * define('SECRET_KEY', 'mAry1HadA15|\/|b17w55w1t3asSn09w');
1000 * </code>
1001 *
1002 * Attention: Do not use above example!
1003 *
1004 * Salting passwords helps against tools which has stored hashed values
1005 * of common dictionary strings. The added values makes it harder to crack
1006 * if given salt string is not weak.
1007 *
1008 * Salting only helps if the string is not predictable and should be
1009 * made up of various characters. Think of the salt as a password for
1010 * securing your passwords, but common among all of your passwords.
1011 * Therefore the salt should be as long as possible as as difficult as
1012 * possible, because you will not have to remember it.
1013 *
1014 * @since 2.5
1015 *
1016 * @return string Salt value from either 'SECRET_KEY' or 'secret' option
1017 */
1018function wp_salt() {
1019        global $wp_default_secret_key;
1020        $secret_key = '';
1021        if ( defined('SECRET_KEY') && ('' != SECRET_KEY) && ( $wp_default_secret_key != SECRET_KEY) )
1022                $secret_key = SECRET_KEY;
1023
1024        if ( defined('SECRET_SALT') ) {
1025                $salt = SECRET_SALT;
1026        } else {
1027                $salt = get_option('secret');
1028                if ( empty($salt) ) {
1029                        $salt = wp_generate_password();
1030                        update_option('secret', $salt);
1031                }
1032        }
1033
1034        return apply_filters('salt', $secret_key . $salt);
1035}
1036endif;
1037
1038if ( !function_exists('wp_hash') ) :
1039/**
1040 * wp_hash() - Get hash of given string
1041 *
1042 * @since 2.0.4
1043 * @uses wp_salt() Get WordPress salt
1044 *
1045 * @param string $data Plain text to hash
1046 * @return string Hash of $data
1047 */
1048function wp_hash($data) {
1049        $salt = wp_salt();
1050
1051        if ( function_exists('hash_hmac') ) {
1052                return hash_hmac('md5', $data, $salt);
1053        } else {
1054                return md5($data . $salt);
1055        }
1056}
1057endif;
1058
1059if ( !function_exists('wp_hash_password') ) :
1060/**
1061 * wp_hash_password() - Create a hash (encrypt) of a plain text password
1062 *
1063 * For integration with other applications, this function can be
1064 * overwritten to instead use the other package password checking
1065 * algorithm.
1066 *
1067 * @since 2.5
1068 * @global object $wp_hasher PHPass object
1069 * @uses PasswordHash::HashPassword
1070 *
1071 * @param string $password Plain text user password to hash
1072 * @return string The hash string of the password
1073 */
1074function wp_hash_password($password) {
1075        global $wp_hasher;
1076
1077        if ( empty($wp_hasher) ) {
1078                require_once( ABSPATH . 'wp-includes/class-phpass.php');
1079                // By default, use the portable hash from phpass
1080                $wp_hasher = new PasswordHash(8, TRUE);
1081        }
1082
1083        return $wp_hasher->HashPassword($password);
1084}
1085endif;
1086
1087if ( !function_exists('wp_check_password') ) :
1088/**
1089 * wp_check_password() - Checks the plaintext password against the encrypted Password
1090 *
1091 * Maintains compatibility between old version and the new cookie
1092 * authentication protocol using PHPass library. The $hash parameter
1093 * is the encrypted password and the function compares the plain text
1094 * password when encypted similarly against the already encrypted
1095 * password to see if they match.
1096 *
1097 * For integration with other applications, this function can be
1098 * overwritten to instead use the other package password checking
1099 * algorithm.
1100 *
1101 * @since 2.5
1102 * @global object $wp_hasher PHPass object used for checking the password
1103 *      against the $hash + $password
1104 * @uses PasswordHash::CheckPassword
1105 *
1106 * @param string $password Plaintext user's password
1107 * @param string $hash Hash of the user's password to check against.
1108 * @return bool False, if the $password does not match the hashed password
1109 */
1110function wp_check_password($password, $hash) {
1111        global $wp_hasher;
1112
1113        if ( strlen($hash) <= 32 )
1114                return ( $hash == md5($password) );
1115
1116        // If the stored hash is longer than an MD5, presume the
1117        // new style phpass portable hash.
1118        if ( empty($wp_hasher) ) {
1119                require_once( ABSPATH . 'wp-includes/class-phpass.php');
1120                // By default, use the portable hash from phpass
1121                $wp_hasher = new PasswordHash(8, TRUE);
1122        }
1123
1124        $check = $wp_hasher->CheckPassword($password, $hash);
1125
1126        return apply_filters('check_password', $check, $password, $hash);
1127}
1128endif;
1129
1130if ( !function_exists('wp_generate_password') ) :
1131/**
1132 * wp_generate_password() - Generates a random password drawn from the defined set of characters
1133 *
1134 * @since 2.5
1135 *
1136 * @return string The random password
1137 **/
1138function wp_generate_password() {
1139        $chars = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
1140        $length = 7;
1141        $password = '';
1142        for ( $i = 0; $i < $length; $i++ )
1143                $password .= substr($chars, mt_rand(0, 61), 1);
1144        return $password;
1145}
1146endif;
1147
1148if ( !function_exists('wp_set_password') ) :
1149/**
1150 * wp_set_password() - Updates the user's password with a new encrypted one
1151 *
1152 * For integration with other applications, this function can be
1153 * overwritten to instead use the other package password checking
1154 * algorithm.
1155 *
1156 * @since 2.5
1157 * @uses $wpdb WordPress database object for queries
1158 * @uses wp_hash_password() Used to encrypt the user's password before passing to the database
1159 *
1160 * @param string $password The plaintext new user password
1161 * @param int $user_id User ID
1162 */
1163function wp_set_password( $password, $user_id ) {
1164        global $wpdb;
1165
1166        $hash = wp_hash_password($password);
1167        $query = $wpdb->prepare("UPDATE $wpdb->users SET user_pass = %s, user_activation_key = '' WHERE ID = %d", $hash, $user_id);
1168        $wpdb->query($query);
1169        wp_cache_delete($user_id, 'users');
1170}
1171endif;
1172
1173if ( !function_exists( 'get_avatar' ) ) :
1174/**
1175 * get_avatar() - Get avatar for a user
1176 *
1177 * Retrieve the avatar for a user provided a user ID or email address
1178 *
1179 * @since 2.5
1180 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1181 * @param int $size Size of the avatar image
1182 * @param string $default URL to a default image to use if no avatar is available
1183 * @return string <img> tag for the user's avatar
1184*/
1185function get_avatar( $id_or_email, $size = '64', $default = '' ) {
1186        if ( ! get_option('show_avatars') )
1187                return false;
1188
1189        if ( !is_numeric($size) )
1190                $size = '64';
1191
1192        $email = '';
1193        if ( is_numeric($id_or_email) ) {
1194                $id = (int) $id_or_email;
1195                $user = get_userdata($id);
1196                if ( $user )
1197                        $email = $user->user_email;
1198        } elseif ( is_object($id_or_email) ) {
1199                if ( !empty($id_or_email->user_id) ) {
1200                        $id = (int) $id_or_email->user_id;
1201                        $user = get_userdata($id);
1202                        if ( $user)
1203                                $email = $user->user_email;
1204                } elseif ( !empty($id_or_email->comment_author_email) ) {
1205                        $email = $id_or_email->comment_author_email;
1206                }
1207        } else {
1208                $email = $id_or_email;
1209        }
1210
1211        if ( empty($default) )
1212                $default = "http://www.gravatar.com/avatar/ad516503a11cd5ca435acc9bb6523536.jpg?s=$size"; // ad516503a11cd5ca435acc9bb6523536 == md5('unknown@gravatar.com')
1213
1214        if ( !empty($email) ) {
1215                $out = 'http://www.gravatar.com/avatar/';
1216                $out .= md5( strtolower( $email ) );
1217                $out .= '.jpg?s='.$size;
1218                $out .= '&amp;d=' . urlencode( $default );
1219
1220                $rating = get_option('avatar_rating');
1221                if ( !empty( $rating ) )
1222                        $out .= "&amp;r={$rating}";
1223
1224                $avatar = "<img alt='' src='{$out}' class='avatar avatar-{$size}' height='{$size}' width='{$size}' />";
1225        } else {
1226                $avatar = "<img alt='' src='{$default}' />";
1227        }
1228
1229        return apply_filters('get_avatar', $avatar, $id_or_email, $size, $default);
1230}
1231endif;
1232
1233if ( !function_exists('wp_setcookie') ) :
1234/**
1235 * wp_setcookie() - Sets a cookie for a user who just logged in
1236 *
1237 * @since 1.5
1238 * @deprecated Use wp_set_auth_cookie()
1239 * @see wp_set_auth_cookie()
1240 *
1241 * @param string  $username The user's username
1242 * @param string  $password Optional. The user's password
1243 * @param bool $already_md5 Optional. Whether the password has already been through MD5
1244 * @param string $home Optional. Will be used instead of COOKIEPATH if set
1245 * @param string $siteurl Optional. Will be used instead of SITECOOKIEPATH if set
1246 * @param bool $remember Optional. Remember that the user is logged in
1247 */
1248function wp_setcookie($username, $password = '', $already_md5 = false, $home = '', $siteurl = '', $remember = false) {
1249        _deprecated_function( __FUNCTION__, '2.5', 'wp_set_auth_cookie()' );
1250        $user = get_userdatabylogin($username);
1251        wp_set_auth_cookie($user->ID, $remember);
1252}
1253endif;
1254
1255if ( !function_exists('wp_clearcookie') ) :
1256/**
1257 * wp_clearcookie() - Clears the authentication cookie, logging the user out
1258 *
1259 * @since 1.5
1260 * @deprecated Use wp_clear_auth_cookie()
1261 * @see wp_clear_auth_cookie()
1262 */
1263function wp_clearcookie() {
1264        _deprecated_function( __FUNCTION__, '2.5', 'wp_clear_auth_cookie()' );
1265        wp_clear_auth_cookie();
1266}
1267endif;
1268
1269if ( !function_exists('wp_get_cookie_login') ):
1270/**
1271 * wp_get_cookie_login() - Gets the user cookie login
1272 *
1273 * This function is deprecated and should no longer be extended as it won't
1274 * be used anywhere in WordPress. Also, plugins shouldn't use it either.
1275 *
1276 * @since 2.0.4
1277 * @deprecated No alternative
1278 *
1279 * @return bool Always returns false
1280 */
1281function wp_get_cookie_login() {
1282        _deprecated_function( __FUNCTION__, '2.5', '' );
1283        return false;
1284}
1285endif;
1286
1287if ( !function_exists('wp_login') ) :
1288/**
1289 * wp_login() - Checks a users login information and logs them in if it checks out
1290 *
1291 * Use the global $error to get the reason why the login failed.
1292 * If the username is blank, no error will be set, so assume
1293 * blank username on that case.
1294 *
1295 * Plugins extending this function should also provide the global
1296 * $error and set what the error is, so that those checking the
1297 * global for why there was a failure can utilize it later.
1298 *
1299 * @since 1.2.2
1300 * @deprecated Use wp_signin()
1301 * @global string $error Error when false is returned
1302 *
1303 * @param string $username User's username
1304 * @param string $password User's password
1305 * @param bool $deprecated Not used
1306 * @return bool False on login failure, true on successful check
1307 */
1308function wp_login($username, $password, $deprecated = '') {
1309        global $error;
1310
1311        $user = wp_authenticate($username, $password);
1312
1313        if ( ! is_wp_error($user) )
1314                return true;
1315
1316        $error = $user->get_error_message();
1317        return false;
1318}
1319endif;
1320
1321?>