3 * These functions can be replaced via plugins. If plugins do not redefine these
4 * functions, then these will be used instead.
9 if ( !function_exists('wp_set_current_user') ) :
11 * Changes the current user by ID or name.
13 * Set $id to null and specify a name if you do not know a user's ID.
15 * Some WordPress functionality is based on the current user and not based on
16 * the signed in user. Therefore, it opens the ability to edit and perform
17 * actions on users who aren't signed in.
20 * @global object $current_user The current user object which holds the user data.
21 * @uses do_action() Calls 'set_current_user' hook after setting the current user.
23 * @param int $id User ID
24 * @param string $name User's username
25 * @return WP_User Current user User object
27 function wp_set_current_user($id, $name = '') {
30 if ( isset( $current_user ) && ( $current_user instanceof WP_User ) && ( $id == $current_user->ID ) )
33 $current_user = new WP_User( $id, $name );
35 setup_userdata( $current_user->ID );
37 do_action('set_current_user');
43 if ( !function_exists('wp_get_current_user') ) :
45 * Retrieve the current user object.
49 * @return WP_User Current user WP_User object
51 function wp_get_current_user() {
54 get_currentuserinfo();
60 if ( !function_exists('get_currentuserinfo') ) :
62 * Populate global variables with information about the currently logged in user.
64 * Will set the current user, if the current user is not set. The current user
65 * will be set to the logged in person. If no user is logged in, then it will
66 * set the current user to 0, which is invalid and won't have any permissions.
69 * @uses $current_user Checks if the current user is set
70 * @uses wp_validate_auth_cookie() Retrieves current logged in user.
72 * @return bool|null False on XMLRPC Request and invalid auth cookie. Null when current user set
74 function get_currentuserinfo() {
77 if ( ! empty( $current_user ) ) {
78 if ( $current_user instanceof WP_User )
81 // Upgrade stdClass to WP_User
82 if ( is_object( $current_user ) && isset( $current_user->ID ) ) {
83 $cur_id = $current_user->ID;
85 wp_set_current_user( $cur_id );
89 // $current_user has a junk value. Force to WP_User with ID 0.
91 wp_set_current_user( 0 );
95 if ( defined('XMLRPC_REQUEST') && XMLRPC_REQUEST ) {
96 wp_set_current_user( 0 );
100 if ( ! $user = wp_validate_auth_cookie() ) {
101 if ( is_blog_admin() || is_network_admin() || empty( $_COOKIE[LOGGED_IN_COOKIE] ) || !$user = wp_validate_auth_cookie( $_COOKIE[LOGGED_IN_COOKIE], 'logged_in' ) ) {
102 wp_set_current_user( 0 );
107 wp_set_current_user( $user );
111 if ( !function_exists('get_userdata') ) :
113 * Retrieve user info by user ID.
117 * @param int $user_id User ID
118 * @return bool|object False on failure, WP_User object on success
120 function get_userdata( $user_id ) {
121 return get_user_by( 'id', $user_id );
125 if ( !function_exists('get_user_by') ) :
127 * Retrieve user info by a given field
131 * @param string $field The field to retrieve the user with. id | slug | email | login
132 * @param int|string $value A value for $field. A user ID, slug, email address, or login name.
133 * @return bool|object False on failure, WP_User object on success
135 function get_user_by( $field, $value ) {
136 $userdata = WP_User::get_data_by( $field, $value );
142 $user->init( $userdata );
148 if ( !function_exists('cache_users') ) :
150 * Retrieve info for user lists to prevent multiple queries by get_userdata()
154 * @param array $user_ids User ID numbers list
156 function cache_users( $user_ids ) {
159 $clean = _get_non_cached_ids( $user_ids, 'users' );
161 if ( empty( $clean ) )
164 $list = implode( ',', $clean );
166 $users = $wpdb->get_results( "SELECT * FROM $wpdb->users WHERE ID IN ($list)" );
169 foreach ( $users as $user ) {
170 update_user_caches( $user );
173 update_meta_cache( 'user', $ids );
177 if ( !function_exists( 'wp_mail' ) ) :
179 * Send mail, similar to PHP's mail
181 * A true return value does not automatically mean that the user received the
182 * email successfully. It just only means that the method used was able to
183 * process the request without any errors.
185 * Using the two 'wp_mail_from' and 'wp_mail_from_name' hooks allow from
186 * creating a from address like 'Name <email@address.com>' when both are set. If
187 * just 'wp_mail_from' is set, then just the email address will be used with no
190 * The default content type is 'text/plain' which does not allow using HTML.
191 * However, you can set the content type of the email by using the
192 * 'wp_mail_content_type' filter.
194 * The default charset is based on the charset used on the blog. The charset can
195 * be set using the 'wp_mail_charset' filter.
198 * @uses apply_filters() Calls 'wp_mail' hook on an array of all of the parameters.
199 * @uses apply_filters() Calls 'wp_mail_from' hook to get the from email address.
200 * @uses apply_filters() Calls 'wp_mail_from_name' hook to get the from address name.
201 * @uses apply_filters() Calls 'wp_mail_content_type' hook to get the email content type.
202 * @uses apply_filters() Calls 'wp_mail_charset' hook to get the email charset
203 * @uses do_action_ref_array() Calls 'phpmailer_init' hook on the reference to
207 * @param string|array $to Array or comma-separated list of email addresses to send message.
208 * @param string $subject Email subject
209 * @param string $message Message contents
210 * @param string|array $headers Optional. Additional headers.
211 * @param string|array $attachments Optional. Files to attach.
212 * @return bool Whether the email contents were sent successfully.
214 function wp_mail( $to, $subject, $message, $headers = '', $attachments = array() ) {
215 // Compact the input, apply the filters, and extract them back out
216 extract( apply_filters( 'wp_mail', compact( 'to', 'subject', 'message', 'headers', 'attachments' ) ) );
218 if ( !is_array($attachments) )
219 $attachments = explode( "\n", str_replace( "\r\n", "\n", $attachments ) );
223 // (Re)create it, if it's gone missing
224 if ( !is_object( $phpmailer ) || !is_a( $phpmailer, 'PHPMailer' ) ) {
225 require_once ABSPATH . WPINC . '/class-phpmailer.php';
226 require_once ABSPATH . WPINC . '/class-smtp.php';
227 $phpmailer = new PHPMailer( true );
231 if ( empty( $headers ) ) {
234 if ( !is_array( $headers ) ) {
235 // Explode the headers out, so this function can take both
236 // string headers and an array of headers.
237 $tempheaders = explode( "\n", str_replace( "\r\n", "\n", $headers ) );
239 $tempheaders = $headers;
245 // If it's actually got contents
246 if ( !empty( $tempheaders ) ) {
247 // Iterate through the raw headers
248 foreach ( (array) $tempheaders as $header ) {
249 if ( strpos($header, ':') === false ) {
250 if ( false !== stripos( $header, 'boundary=' ) ) {
251 $parts = preg_split('/boundary=/i', trim( $header ) );
252 $boundary = trim( str_replace( array( "'", '"' ), '', $parts[1] ) );
257 list( $name, $content ) = explode( ':', trim( $header ), 2 );
260 $name = trim( $name );
261 $content = trim( $content );
263 switch ( strtolower( $name ) ) {
264 // Mainly for legacy -- process a From: header if it's there
266 if ( strpos($content, '<' ) !== false ) {
267 // So... making my life hard again?
268 $from_name = substr( $content, 0, strpos( $content, '<' ) - 1 );
269 $from_name = str_replace( '"', '', $from_name );
270 $from_name = trim( $from_name );
272 $from_email = substr( $content, strpos( $content, '<' ) + 1 );
273 $from_email = str_replace( '>', '', $from_email );
274 $from_email = trim( $from_email );
276 $from_email = trim( $content );
280 if ( strpos( $content, ';' ) !== false ) {
281 list( $type, $charset ) = explode( ';', $content );
282 $content_type = trim( $type );
283 if ( false !== stripos( $charset, 'charset=' ) ) {
284 $charset = trim( str_replace( array( 'charset=', '"' ), '', $charset ) );
285 } elseif ( false !== stripos( $charset, 'boundary=' ) ) {
286 $boundary = trim( str_replace( array( 'BOUNDARY=', 'boundary=', '"' ), '', $charset ) );
290 $content_type = trim( $content );
294 $cc = array_merge( (array) $cc, explode( ',', $content ) );
297 $bcc = array_merge( (array) $bcc, explode( ',', $content ) );
300 // Add it to our grand headers array
301 $headers[trim( $name )] = trim( $content );
308 // Empty out the values that may be set
309 $phpmailer->ClearAddresses();
310 $phpmailer->ClearAllRecipients();
311 $phpmailer->ClearAttachments();
312 $phpmailer->ClearBCCs();
313 $phpmailer->ClearCCs();
314 $phpmailer->ClearCustomHeaders();
315 $phpmailer->ClearReplyTos();
317 // From email and name
318 // If we don't have a name from the input headers
319 if ( !isset( $from_name ) )
320 $from_name = 'WordPress';
322 /* If we don't have an email from the input headers default to wordpress@$sitename
323 * Some hosts will block outgoing mail from this address if it doesn't exist but
324 * there's no easy alternative. Defaulting to admin_email might appear to be another
325 * option but some hosts may refuse to relay mail from an unknown domain. See
326 * http://trac.wordpress.org/ticket/5007.
329 if ( !isset( $from_email ) ) {
330 // Get the site domain and get rid of www.
331 $sitename = strtolower( $_SERVER['SERVER_NAME'] );
332 if ( substr( $sitename, 0, 4 ) == 'www.' ) {
333 $sitename = substr( $sitename, 4 );
336 $from_email = 'wordpress@' . $sitename;
339 // Plugin authors can override the potentially troublesome default
340 $phpmailer->From = apply_filters( 'wp_mail_from' , $from_email );
341 $phpmailer->FromName = apply_filters( 'wp_mail_from_name', $from_name );
343 // Set destination addresses
344 if ( !is_array( $to ) )
345 $to = explode( ',', $to );
347 foreach ( (array) $to as $recipient ) {
349 // Break $recipient into name and address parts if in the format "Foo <bar@baz.com>"
350 $recipient_name = '';
351 if( preg_match( '/(.*)<(.+)>/', $recipient, $matches ) ) {
352 if ( count( $matches ) == 3 ) {
353 $recipient_name = $matches[1];
354 $recipient = $matches[2];
357 $phpmailer->AddAddress( $recipient, $recipient_name);
358 } catch ( phpmailerException $e ) {
363 // Set mail's subject and body
364 $phpmailer->Subject = $subject;
365 $phpmailer->Body = $message;
367 // Add any CC and BCC recipients
368 if ( !empty( $cc ) ) {
369 foreach ( (array) $cc as $recipient ) {
371 // Break $recipient into name and address parts if in the format "Foo <bar@baz.com>"
372 $recipient_name = '';
373 if( preg_match( '/(.*)<(.+)>/', $recipient, $matches ) ) {
374 if ( count( $matches ) == 3 ) {
375 $recipient_name = $matches[1];
376 $recipient = $matches[2];
379 $phpmailer->AddCc( $recipient, $recipient_name );
380 } catch ( phpmailerException $e ) {
386 if ( !empty( $bcc ) ) {
387 foreach ( (array) $bcc as $recipient) {
389 // Break $recipient into name and address parts if in the format "Foo <bar@baz.com>"
390 $recipient_name = '';
391 if( preg_match( '/(.*)<(.+)>/', $recipient, $matches ) ) {
392 if ( count( $matches ) == 3 ) {
393 $recipient_name = $matches[1];
394 $recipient = $matches[2];
397 $phpmailer->AddBcc( $recipient, $recipient_name );
398 } catch ( phpmailerException $e ) {
404 // Set to use PHP's mail()
405 $phpmailer->IsMail();
407 // Set Content-Type and charset
408 // If we don't have a content-type from the input headers
409 if ( !isset( $content_type ) )
410 $content_type = 'text/plain';
412 $content_type = apply_filters( 'wp_mail_content_type', $content_type );
414 $phpmailer->ContentType = $content_type;
416 // Set whether it's plaintext, depending on $content_type
417 if ( 'text/html' == $content_type )
418 $phpmailer->IsHTML( true );
420 // If we don't have a charset from the input headers
421 if ( !isset( $charset ) )
422 $charset = get_bloginfo( 'charset' );
424 // Set the content-type and charset
425 $phpmailer->CharSet = apply_filters( 'wp_mail_charset', $charset );
427 // Set custom headers
428 if ( !empty( $headers ) ) {
429 foreach( (array) $headers as $name => $content ) {
430 $phpmailer->AddCustomHeader( sprintf( '%1$s: %2$s', $name, $content ) );
433 if ( false !== stripos( $content_type, 'multipart' ) && ! empty($boundary) )
434 $phpmailer->AddCustomHeader( sprintf( "Content-Type: %s;\n\t boundary=\"%s\"", $content_type, $boundary ) );
437 if ( !empty( $attachments ) ) {
438 foreach ( $attachments as $attachment ) {
440 $phpmailer->AddAttachment($attachment);
441 } catch ( phpmailerException $e ) {
447 do_action_ref_array( 'phpmailer_init', array( &$phpmailer ) );
452 } catch ( phpmailerException $e ) {
460 if ( !function_exists('wp_authenticate') ) :
462 * Checks a user's login information and logs them in if it checks out.
466 * @param string $username User's username
467 * @param string $password User's password
468 * @return WP_Error|WP_User WP_User object if login successful, otherwise WP_Error object.
470 function wp_authenticate($username, $password) {
471 $username = sanitize_user($username);
472 $password = trim($password);
474 $user = apply_filters('authenticate', null, $username, $password);
476 if ( $user == null ) {
477 // TODO what should the error message be? (Or would these even happen?)
478 // Only needed if all authentication handlers fail to return anything.
479 $user = new WP_Error('authentication_failed', __('<strong>ERROR</strong>: Invalid username or incorrect password.'));
482 $ignore_codes = array('empty_username', 'empty_password');
484 if (is_wp_error($user) && !in_array($user->get_error_code(), $ignore_codes) ) {
485 do_action('wp_login_failed', $username);
492 if ( !function_exists('wp_logout') ) :
494 * Log the current user out.
498 function wp_logout() {
499 wp_clear_auth_cookie();
500 do_action('wp_logout');
504 if ( !function_exists('wp_validate_auth_cookie') ) :
506 * Validates authentication cookie.
508 * The checks include making sure that the authentication cookie is set and
509 * pulling in the contents (if $cookie is not used).
511 * Makes sure the cookie is not expired. Verifies the hash in cookie is what is
512 * should be and compares the two.
516 * @param string $cookie Optional. If used, will validate contents instead of cookie's
517 * @param string $scheme Optional. The cookie scheme to use: auth, secure_auth, or logged_in
518 * @return bool|int False if invalid cookie, User ID if valid.
520 function wp_validate_auth_cookie($cookie = '', $scheme = '') {
521 if ( ! $cookie_elements = wp_parse_auth_cookie($cookie, $scheme) ) {
522 do_action('auth_cookie_malformed', $cookie, $scheme);
526 extract($cookie_elements, EXTR_OVERWRITE);
528 $expired = $expiration;
530 // Allow a grace period for POST and AJAX requests
531 if ( defined('DOING_AJAX') || 'POST' == $_SERVER['REQUEST_METHOD'] )
532 $expired += HOUR_IN_SECONDS;
534 // Quick check to see if an honest cookie has expired
535 if ( $expired < time() ) {
536 do_action('auth_cookie_expired', $cookie_elements);
540 $user = get_user_by('login', $username);
542 do_action('auth_cookie_bad_username', $cookie_elements);
546 $pass_frag = substr($user->user_pass, 8, 4);
548 $key = wp_hash($username . $pass_frag . '|' . $expiration, $scheme);
549 $hash = hash_hmac('md5', $username . '|' . $expiration, $key);
551 if ( $hmac != $hash ) {
552 do_action('auth_cookie_bad_hash', $cookie_elements);
556 if ( $expiration < time() ) // AJAX/POST grace period set above
557 $GLOBALS['login_grace_period'] = 1;
559 do_action('auth_cookie_valid', $cookie_elements, $user);
565 if ( !function_exists('wp_generate_auth_cookie') ) :
567 * Generate authentication cookie contents.
570 * @uses apply_filters() Calls 'auth_cookie' hook on $cookie contents, User ID
571 * and expiration of cookie.
573 * @param int $user_id User ID
574 * @param int $expiration Cookie expiration in seconds
575 * @param string $scheme Optional. The cookie scheme to use: auth, secure_auth, or logged_in
576 * @return string Authentication cookie contents
578 function wp_generate_auth_cookie($user_id, $expiration, $scheme = 'auth') {
579 $user = get_userdata($user_id);
581 $pass_frag = substr($user->user_pass, 8, 4);
583 $key = wp_hash($user->user_login . $pass_frag . '|' . $expiration, $scheme);
584 $hash = hash_hmac('md5', $user->user_login . '|' . $expiration, $key);
586 $cookie = $user->user_login . '|' . $expiration . '|' . $hash;
588 return apply_filters('auth_cookie', $cookie, $user_id, $expiration, $scheme);
592 if ( !function_exists('wp_parse_auth_cookie') ) :
594 * Parse a cookie into its components
598 * @param string $cookie
599 * @param string $scheme Optional. The cookie scheme to use: auth, secure_auth, or logged_in
600 * @return array Authentication cookie components
602 function wp_parse_auth_cookie($cookie = '', $scheme = '') {
603 if ( empty($cookie) ) {
606 $cookie_name = AUTH_COOKIE;
609 $cookie_name = SECURE_AUTH_COOKIE;
612 $cookie_name = LOGGED_IN_COOKIE;
616 $cookie_name = SECURE_AUTH_COOKIE;
617 $scheme = 'secure_auth';
619 $cookie_name = AUTH_COOKIE;
624 if ( empty($_COOKIE[$cookie_name]) )
626 $cookie = $_COOKIE[$cookie_name];
629 $cookie_elements = explode('|', $cookie);
630 if ( count($cookie_elements) != 3 )
633 list($username, $expiration, $hmac) = $cookie_elements;
635 return compact('username', 'expiration', 'hmac', 'scheme');
639 if ( !function_exists('wp_set_auth_cookie') ) :
641 * Sets the authentication cookies based User ID.
643 * The $remember parameter increases the time that the cookie will be kept. The
644 * default the cookie is kept without remembering is two days. When $remember is
645 * set, the cookies will be kept for 14 days or two weeks.
649 * @param int $user_id User ID
650 * @param bool $remember Whether to remember the user
652 function wp_set_auth_cookie($user_id, $remember = false, $secure = '') {
654 $expiration = $expire = time() + apply_filters('auth_cookie_expiration', 1209600, $user_id, $remember);
656 $expiration = time() + apply_filters('auth_cookie_expiration', 172800, $user_id, $remember);
660 if ( '' === $secure )
663 $secure = apply_filters('secure_auth_cookie', $secure, $user_id);
664 $secure_logged_in_cookie = apply_filters('secure_logged_in_cookie', false, $user_id, $secure);
667 $auth_cookie_name = SECURE_AUTH_COOKIE;
668 $scheme = 'secure_auth';
670 $auth_cookie_name = AUTH_COOKIE;
674 $auth_cookie = wp_generate_auth_cookie($user_id, $expiration, $scheme);
675 $logged_in_cookie = wp_generate_auth_cookie($user_id, $expiration, 'logged_in');
677 do_action('set_auth_cookie', $auth_cookie, $expire, $expiration, $user_id, $scheme);
678 do_action('set_logged_in_cookie', $logged_in_cookie, $expire, $expiration, $user_id, 'logged_in');
680 setcookie($auth_cookie_name, $auth_cookie, $expire, PLUGINS_COOKIE_PATH, COOKIE_DOMAIN, $secure, true);
681 setcookie($auth_cookie_name, $auth_cookie, $expire, ADMIN_COOKIE_PATH, COOKIE_DOMAIN, $secure, true);
682 setcookie(LOGGED_IN_COOKIE, $logged_in_cookie, $expire, COOKIEPATH, COOKIE_DOMAIN, $secure_logged_in_cookie, true);
683 if ( COOKIEPATH != SITECOOKIEPATH )
684 setcookie(LOGGED_IN_COOKIE, $logged_in_cookie, $expire, SITECOOKIEPATH, COOKIE_DOMAIN, $secure_logged_in_cookie, true);
688 if ( !function_exists('wp_clear_auth_cookie') ) :
690 * Removes all of the cookies associated with authentication.
694 function wp_clear_auth_cookie() {
695 do_action('clear_auth_cookie');
697 setcookie( AUTH_COOKIE, ' ', time() - YEAR_IN_SECONDS, ADMIN_COOKIE_PATH, COOKIE_DOMAIN );
698 setcookie( SECURE_AUTH_COOKIE, ' ', time() - YEAR_IN_SECONDS, ADMIN_COOKIE_PATH, COOKIE_DOMAIN );
699 setcookie( AUTH_COOKIE, ' ', time() - YEAR_IN_SECONDS, PLUGINS_COOKIE_PATH, COOKIE_DOMAIN );
700 setcookie( SECURE_AUTH_COOKIE, ' ', time() - YEAR_IN_SECONDS, PLUGINS_COOKIE_PATH, COOKIE_DOMAIN );
701 setcookie( LOGGED_IN_COOKIE, ' ', time() - YEAR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN );
702 setcookie( LOGGED_IN_COOKIE, ' ', time() - YEAR_IN_SECONDS, SITECOOKIEPATH, COOKIE_DOMAIN );
705 setcookie( AUTH_COOKIE, ' ', time() - YEAR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN );
706 setcookie( AUTH_COOKIE, ' ', time() - YEAR_IN_SECONDS, SITECOOKIEPATH, COOKIE_DOMAIN );
707 setcookie( SECURE_AUTH_COOKIE, ' ', time() - YEAR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN );
708 setcookie( SECURE_AUTH_COOKIE, ' ', time() - YEAR_IN_SECONDS, SITECOOKIEPATH, COOKIE_DOMAIN );
710 // Even older cookies
711 setcookie( USER_COOKIE, ' ', time() - YEAR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN );
712 setcookie( PASS_COOKIE, ' ', time() - YEAR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN );
713 setcookie( USER_COOKIE, ' ', time() - YEAR_IN_SECONDS, SITECOOKIEPATH, COOKIE_DOMAIN );
714 setcookie( PASS_COOKIE, ' ', time() - YEAR_IN_SECONDS, SITECOOKIEPATH, COOKIE_DOMAIN );
718 if ( !function_exists('is_user_logged_in') ) :
720 * Checks if the current visitor is a logged in user.
724 * @return bool True if user is logged in, false if not logged in.
726 function is_user_logged_in() {
727 $user = wp_get_current_user();
729 if ( ! $user->exists() )
736 if ( !function_exists('auth_redirect') ) :
738 * Checks if a user is logged in, if not it redirects them to the login page.
742 function auth_redirect() {
743 // Checks if a user is logged in, if not redirects them to the login page
745 $secure = ( is_ssl() || force_ssl_admin() );
747 $secure = apply_filters('secure_auth_redirect', $secure);
749 // If https is required and request is http, redirect
750 if ( $secure && !is_ssl() && false !== strpos($_SERVER['REQUEST_URI'], 'wp-admin') ) {
751 if ( 0 === strpos( $_SERVER['REQUEST_URI'], 'http' ) ) {
752 wp_redirect( set_url_scheme( $_SERVER['REQUEST_URI'], 'https' ) );
755 wp_redirect( 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );
760 if ( is_user_admin() )
761 $scheme = 'logged_in';
763 $scheme = apply_filters( 'auth_redirect_scheme', '' );
765 if ( $user_id = wp_validate_auth_cookie( '', $scheme) ) {
766 do_action('auth_redirect', $user_id);
768 // If the user wants ssl but the session is not ssl, redirect.
769 if ( !$secure && get_user_option('use_ssl', $user_id) && false !== strpos($_SERVER['REQUEST_URI'], 'wp-admin') ) {
770 if ( 0 === strpos( $_SERVER['REQUEST_URI'], 'http' ) ) {
771 wp_redirect( set_url_scheme( $_SERVER['REQUEST_URI'], 'https' ) );
774 wp_redirect( 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );
779 return; // The cookie is good so we're done
782 // The cookie is no good so force login
785 $redirect = ( strpos( $_SERVER['REQUEST_URI'], '/options.php' ) && wp_get_referer() ) ? wp_get_referer() : set_url_scheme( 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );
787 $login_url = wp_login_url($redirect, true);
789 wp_redirect($login_url);
794 if ( !function_exists('check_admin_referer') ) :
796 * Makes sure that a user was referred from another admin page.
798 * To avoid security exploits.
801 * @uses do_action() Calls 'check_admin_referer' on $action.
803 * @param string $action Action nonce
804 * @param string $query_arg where to look for nonce in $_REQUEST (since 2.5)
806 function check_admin_referer($action = -1, $query_arg = '_wpnonce') {
808 _doing_it_wrong( __FUNCTION__, __( 'You should specify a nonce action to be verified by using the first parameter.' ), '3.2' );
810 $adminurl = strtolower(admin_url());
811 $referer = strtolower(wp_get_referer());
812 $result = isset($_REQUEST[$query_arg]) ? wp_verify_nonce($_REQUEST[$query_arg], $action) : false;
813 if ( !$result && !(-1 == $action && strpos($referer, $adminurl) === 0) ) {
814 wp_nonce_ays($action);
817 do_action('check_admin_referer', $action, $result);
821 if ( !function_exists('check_ajax_referer') ) :
823 * Verifies the AJAX request to prevent processing requests external of the blog.
827 * @param string $action Action nonce
828 * @param string $query_arg where to look for nonce in $_REQUEST (since 2.5)
830 function check_ajax_referer( $action = -1, $query_arg = false, $die = true ) {
832 $nonce = $_REQUEST[$query_arg];
834 $nonce = isset($_REQUEST['_ajax_nonce']) ? $_REQUEST['_ajax_nonce'] : $_REQUEST['_wpnonce'];
836 $result = wp_verify_nonce( $nonce, $action );
838 if ( $die && false == $result ) {
839 if ( defined( 'DOING_AJAX' ) && DOING_AJAX )
845 do_action('check_ajax_referer', $action, $result);
851 if ( !function_exists('wp_redirect') ) :
853 * Redirects to another page.
856 * @uses apply_filters() Calls 'wp_redirect' hook on $location and $status.
858 * @param string $location The path to redirect to
859 * @param int $status Status code to use
860 * @return bool False if $location is not set
862 function wp_redirect($location, $status = 302) {
865 $location = apply_filters('wp_redirect', $location, $status);
866 $status = apply_filters('wp_redirect_status', $status, $location);
868 if ( !$location ) // allows the wp_redirect filter to cancel a redirect
871 $location = wp_sanitize_redirect($location);
873 if ( !$is_IIS && php_sapi_name() != 'cgi-fcgi' )
874 status_header($status); // This causes problems on IIS and some FastCGI setups
876 header("Location: $location", true, $status);
880 if ( !function_exists('wp_sanitize_redirect') ) :
882 * Sanitizes a URL for use in a redirect.
886 * @return string redirect-sanitized URL
888 function wp_sanitize_redirect($location) {
889 $location = preg_replace('|[^a-z0-9-~+_.?#=&;,/:%!]|i', '', $location);
890 $location = wp_kses_no_null($location);
892 // remove %0d and %0a from location
893 $strip = array('%0d', '%0a', '%0D', '%0A');
894 $location = _deep_replace($strip, $location);
899 if ( !function_exists('wp_safe_redirect') ) :
901 * Performs a safe (local) redirect, using wp_redirect().
903 * Checks whether the $location is using an allowed host, if it has an absolute
904 * path. A plugin can therefore set or remove allowed host(s) to or from the
907 * If the host is not allowed, then the redirect is to wp-admin on the siteurl
908 * instead. This prevents malicious redirects which redirect to another host,
909 * but only used in a few places.
912 * @uses wp_validate_redirect() To validate the redirect is to an allowed host.
914 * @return void Does not return anything
916 function wp_safe_redirect($location, $status = 302) {
918 // Need to look at the URL the way it will end up in wp_redirect()
919 $location = wp_sanitize_redirect($location);
921 $location = wp_validate_redirect($location, admin_url());
923 wp_redirect($location, $status);
927 if ( !function_exists('wp_validate_redirect') ) :
929 * Validates a URL for use in a redirect.
931 * Checks whether the $location is using an allowed host, if it has an absolute
932 * path. A plugin can therefore set or remove allowed host(s) to or from the
935 * If the host is not allowed, then the redirect is to $default supplied
938 * @uses apply_filters() Calls 'allowed_redirect_hosts' on an array containing
939 * WordPress host string and $location host string.
941 * @param string $location The redirect to validate
942 * @param string $default The value to return if $location is not allowed
943 * @return string redirect-sanitized URL
945 function wp_validate_redirect($location, $default = '') {
946 // browsers will assume 'http' is your protocol, and will obey a redirect to a URL starting with '//'
947 if ( substr($location, 0, 2) == '//' )
948 $location = 'http:' . $location;
950 // In php 5 parse_url may fail if the URL query part contains http://, bug #38143
951 $test = ( $cut = strpos($location, '?') ) ? substr( $location, 0, $cut ) : $location;
953 $lp = parse_url($test);
955 // Give up if malformed URL
959 // Allow only http and https schemes. No data:, etc.
960 if ( isset($lp['scheme']) && !('http' == $lp['scheme'] || 'https' == $lp['scheme']) )
963 // Reject if scheme is set but host is not. This catches urls like https:host.com for which parse_url does not set the host field.
964 if ( isset($lp['scheme']) && !isset($lp['host']) )
967 $wpp = parse_url(home_url());
969 $allowed_hosts = (array) apply_filters('allowed_redirect_hosts', array($wpp['host']), isset($lp['host']) ? $lp['host'] : '');
971 if ( isset($lp['host']) && ( !in_array($lp['host'], $allowed_hosts) && $lp['host'] != strtolower($wpp['host'])) )
972 $location = $default;
978 if ( ! function_exists('wp_notify_postauthor') ) :
980 * Notify an author of a comment/trackback/pingback to one of their posts.
984 * @param int $comment_id Comment ID
985 * @param string $comment_type Optional. The comment type either 'comment' (default), 'trackback', or 'pingback'
986 * @return bool False if user email does not exist. True on completion.
988 function wp_notify_postauthor( $comment_id, $comment_type = '' ) {
989 $comment = get_comment( $comment_id );
990 $post = get_post( $comment->comment_post_ID );
991 $author = get_userdata( $post->post_author );
993 // The comment was left by the author
994 if ( $comment->user_id == $post->post_author )
997 // The author moderated a comment on his own post
998 if ( $post->post_author == get_current_user_id() )
1001 // If there's no email to send the comment to
1002 if ( '' == $author->user_email )
1005 $comment_author_domain = @gethostbyaddr($comment->comment_author_IP);
1007 // The blogname option is escaped with esc_html on the way into the database in sanitize_option
1008 // we want to reverse this for the plain text arena of emails.
1009 $blogname = wp_specialchars_decode(get_option('blogname'), ENT_QUOTES);
1011 if ( empty( $comment_type ) ) $comment_type = 'comment';
1013 if ('comment' == $comment_type) {
1014 $notify_message = sprintf( __( 'New comment on your post "%s"' ), $post->post_title ) . "\r\n";
1015 /* translators: 1: comment author, 2: author IP, 3: author domain */
1016 $notify_message .= sprintf( __('Author : %1$s (IP: %2$s , %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
1017 $notify_message .= sprintf( __('E-mail : %s'), $comment->comment_author_email ) . "\r\n";
1018 $notify_message .= sprintf( __('URL : %s'), $comment->comment_author_url ) . "\r\n";
1019 $notify_message .= sprintf( __('Whois : http://whois.arin.net/rest/ip/%s'), $comment->comment_author_IP ) . "\r\n";
1020 $notify_message .= __('Comment: ') . "\r\n" . $comment->comment_content . "\r\n\r\n";
1021 $notify_message .= __('You can see all comments on this post here: ') . "\r\n";
1022 /* translators: 1: blog name, 2: post title */
1023 $subject = sprintf( __('[%1$s] Comment: "%2$s"'), $blogname, $post->post_title );
1024 } elseif ('trackback' == $comment_type) {
1025 $notify_message = sprintf( __( 'New trackback on your post "%s"' ), $post->post_title ) . "\r\n";
1026 /* translators: 1: website name, 2: author IP, 3: author domain */
1027 $notify_message .= sprintf( __('Website: %1$s (IP: %2$s , %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
1028 $notify_message .= sprintf( __('URL : %s'), $comment->comment_author_url ) . "\r\n";
1029 $notify_message .= __('Excerpt: ') . "\r\n" . $comment->comment_content . "\r\n\r\n";
1030 $notify_message .= __('You can see all trackbacks on this post here: ') . "\r\n";
1031 /* translators: 1: blog name, 2: post title */
1032 $subject = sprintf( __('[%1$s] Trackback: "%2$s"'), $blogname, $post->post_title );
1033 } elseif ('pingback' == $comment_type) {
1034 $notify_message = sprintf( __( 'New pingback on your post "%s"' ), $post->post_title ) . "\r\n";
1035 /* translators: 1: comment author, 2: author IP, 3: author domain */
1036 $notify_message .= sprintf( __('Website: %1$s (IP: %2$s , %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
1037 $notify_message .= sprintf( __('URL : %s'), $comment->comment_author_url ) . "\r\n";
1038 $notify_message .= __('Excerpt: ') . "\r\n" . sprintf('[...] %s [...]', $comment->comment_content ) . "\r\n\r\n";
1039 $notify_message .= __('You can see all pingbacks on this post here: ') . "\r\n";
1040 /* translators: 1: blog name, 2: post title */
1041 $subject = sprintf( __('[%1$s] Pingback: "%2$s"'), $blogname, $post->post_title );
1043 $notify_message .= get_permalink($comment->comment_post_ID) . "#comments\r\n\r\n";
1044 $notify_message .= sprintf( __('Permalink: %s'), get_permalink( $comment->comment_post_ID ) . '#comment-' . $comment_id ) . "\r\n";
1045 if ( EMPTY_TRASH_DAYS )
1046 $notify_message .= sprintf( __('Trash it: %s'), admin_url("comment.php?action=trash&c=$comment_id") ) . "\r\n";
1048 $notify_message .= sprintf( __('Delete it: %s'), admin_url("comment.php?action=delete&c=$comment_id") ) . "\r\n";
1049 $notify_message .= sprintf( __('Spam it: %s'), admin_url("comment.php?action=spam&c=$comment_id") ) . "\r\n";
1051 $wp_email = 'wordpress@' . preg_replace('#^www\.#', '', strtolower($_SERVER['SERVER_NAME']));
1053 if ( '' == $comment->comment_author ) {
1054 $from = "From: \"$blogname\" <$wp_email>";
1055 if ( '' != $comment->comment_author_email )
1056 $reply_to = "Reply-To: $comment->comment_author_email";
1058 $from = "From: \"$comment->comment_author\" <$wp_email>";
1059 if ( '' != $comment->comment_author_email )
1060 $reply_to = "Reply-To: \"$comment->comment_author_email\" <$comment->comment_author_email>";
1063 $message_headers = "$from\n"
1064 . "Content-Type: text/plain; charset=\"" . get_option('blog_charset') . "\"\n";
1066 if ( isset($reply_to) )
1067 $message_headers .= $reply_to . "\n";
1069 $notify_message = apply_filters('comment_notification_text', $notify_message, $comment_id);
1070 $subject = apply_filters('comment_notification_subject', $subject, $comment_id);
1071 $message_headers = apply_filters('comment_notification_headers', $message_headers, $comment_id);
1073 @wp_mail( $author->user_email, $subject, $notify_message, $message_headers );
1079 if ( !function_exists('wp_notify_moderator') ) :
1081 * Notifies the moderator of the blog about a new comment that is awaiting approval.
1086 * @param int $comment_id Comment ID
1087 * @return bool Always returns true
1089 function wp_notify_moderator($comment_id) {
1092 if ( 0 == get_option( 'moderation_notify' ) )
1095 $comment = get_comment($comment_id);
1096 $post = get_post($comment->comment_post_ID);
1097 $user = get_userdata( $post->post_author );
1098 // Send to the administration and to the post author if the author can modify the comment.
1099 $email_to = array( get_option('admin_email') );
1100 if ( user_can($user->ID, 'edit_comment', $comment_id) && !empty($user->user_email) && ( get_option('admin_email') != $user->user_email) )
1101 $email_to[] = $user->user_email;
1103 $comment_author_domain = @gethostbyaddr($comment->comment_author_IP);
1104 $comments_waiting = $wpdb->get_var("SELECT count(comment_ID) FROM $wpdb->comments WHERE comment_approved = '0'");
1106 // The blogname option is escaped with esc_html on the way into the database in sanitize_option
1107 // we want to reverse this for the plain text arena of emails.
1108 $blogname = wp_specialchars_decode(get_option('blogname'), ENT_QUOTES);
1110 switch ($comment->comment_type)
1113 $notify_message = sprintf( __('A new trackback on the post "%s" is waiting for your approval'), $post->post_title ) . "\r\n";
1114 $notify_message .= get_permalink($comment->comment_post_ID) . "\r\n\r\n";
1115 $notify_message .= sprintf( __('Website : %1$s (IP: %2$s , %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
1116 $notify_message .= sprintf( __('URL : %s'), $comment->comment_author_url ) . "\r\n";
1117 $notify_message .= __('Trackback excerpt: ') . "\r\n" . $comment->comment_content . "\r\n\r\n";
1120 $notify_message = sprintf( __('A new pingback on the post "%s" is waiting for your approval'), $post->post_title ) . "\r\n";
1121 $notify_message .= get_permalink($comment->comment_post_ID) . "\r\n\r\n";
1122 $notify_message .= sprintf( __('Website : %1$s (IP: %2$s , %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
1123 $notify_message .= sprintf( __('URL : %s'), $comment->comment_author_url ) . "\r\n";
1124 $notify_message .= __('Pingback excerpt: ') . "\r\n" . $comment->comment_content . "\r\n\r\n";
1127 $notify_message = sprintf( __('A new comment on the post "%s" is waiting for your approval'), $post->post_title ) . "\r\n";
1128 $notify_message .= get_permalink($comment->comment_post_ID) . "\r\n\r\n";
1129 $notify_message .= sprintf( __('Author : %1$s (IP: %2$s , %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
1130 $notify_message .= sprintf( __('E-mail : %s'), $comment->comment_author_email ) . "\r\n";
1131 $notify_message .= sprintf( __('URL : %s'), $comment->comment_author_url ) . "\r\n";
1132 $notify_message .= sprintf( __('Whois : http://whois.arin.net/rest/ip/%s'), $comment->comment_author_IP ) . "\r\n";
1133 $notify_message .= __('Comment: ') . "\r\n" . $comment->comment_content . "\r\n\r\n";
1137 $notify_message .= sprintf( __('Approve it: %s'), admin_url("comment.php?action=approve&c=$comment_id") ) . "\r\n";
1138 if ( EMPTY_TRASH_DAYS )
1139 $notify_message .= sprintf( __('Trash it: %s'), admin_url("comment.php?action=trash&c=$comment_id") ) . "\r\n";
1141 $notify_message .= sprintf( __('Delete it: %s'), admin_url("comment.php?action=delete&c=$comment_id") ) . "\r\n";
1142 $notify_message .= sprintf( __('Spam it: %s'), admin_url("comment.php?action=spam&c=$comment_id") ) . "\r\n";
1144 $notify_message .= sprintf( _n('Currently %s comment is waiting for approval. Please visit the moderation panel:',
1145 'Currently %s comments are waiting for approval. Please visit the moderation panel:', $comments_waiting), number_format_i18n($comments_waiting) ) . "\r\n";
1146 $notify_message .= admin_url("edit-comments.php?comment_status=moderated") . "\r\n";
1148 $subject = sprintf( __('[%1$s] Please moderate: "%2$s"'), $blogname, $post->post_title );
1149 $message_headers = '';
1151 $notify_message = apply_filters('comment_moderation_text', $notify_message, $comment_id);
1152 $subject = apply_filters('comment_moderation_subject', $subject, $comment_id);
1153 $message_headers = apply_filters('comment_moderation_headers', $message_headers);
1155 foreach ( $email_to as $email )
1156 @wp_mail($email, $subject, $notify_message, $message_headers);
1162 if ( !function_exists('wp_password_change_notification') ) :
1164 * Notify the blog admin of a user changing password, normally via email.
1168 * @param object $user User Object
1170 function wp_password_change_notification(&$user) {
1171 // send a copy of password change notification to the admin
1172 // but check to see if it's the admin whose password we're changing, and skip this
1173 if ( $user->user_email != get_option('admin_email') ) {
1174 $message = sprintf(__('Password Lost and Changed for user: %s'), $user->user_login) . "\r\n";
1175 // The blogname option is escaped with esc_html on the way into the database in sanitize_option
1176 // we want to reverse this for the plain text arena of emails.
1177 $blogname = wp_specialchars_decode(get_option('blogname'), ENT_QUOTES);
1178 wp_mail(get_option('admin_email'), sprintf(__('[%s] Password Lost/Changed'), $blogname), $message);
1183 if ( !function_exists('wp_new_user_notification') ) :
1185 * Notify the blog admin of a new user, normally via email.
1189 * @param int $user_id User ID
1190 * @param string $plaintext_pass Optional. The user's plaintext password
1192 function wp_new_user_notification($user_id, $plaintext_pass = '') {
1193 $user = get_userdata( $user_id );
1195 $user_login = stripslashes($user->user_login);
1196 $user_email = stripslashes($user->user_email);
1198 // The blogname option is escaped with esc_html on the way into the database in sanitize_option
1199 // we want to reverse this for the plain text arena of emails.
1200 $blogname = wp_specialchars_decode(get_option('blogname'), ENT_QUOTES);
1202 $message = sprintf(__('New user registration on your site %s:'), $blogname) . "\r\n\r\n";
1203 $message .= sprintf(__('Username: %s'), $user_login) . "\r\n\r\n";
1204 $message .= sprintf(__('E-mail: %s'), $user_email) . "\r\n";
1206 @wp_mail(get_option('admin_email'), sprintf(__('[%s] New User Registration'), $blogname), $message);
1208 if ( empty($plaintext_pass) )
1211 $message = sprintf(__('Username: %s'), $user_login) . "\r\n";
1212 $message .= sprintf(__('Password: %s'), $plaintext_pass) . "\r\n";
1213 $message .= wp_login_url() . "\r\n";
1215 wp_mail($user_email, sprintf(__('[%s] Your username and password'), $blogname), $message);
1220 if ( !function_exists('wp_nonce_tick') ) :
1222 * Get the time-dependent variable for nonce creation.
1224 * A nonce has a lifespan of two ticks. Nonces in their second tick may be
1225 * updated, e.g. by autosave.
1231 function wp_nonce_tick() {
1232 $nonce_life = apply_filters( 'nonce_life', DAY_IN_SECONDS );
1234 return ceil(time() / ( $nonce_life / 2 ));
1238 if ( !function_exists('wp_verify_nonce') ) :
1240 * Verify that correct nonce was used with time limit.
1242 * The user is given an amount of time to use the token, so therefore, since the
1243 * UID and $action remain the same, the independent variable is the time.
1247 * @param string $nonce Nonce that was used in the form to verify
1248 * @param string|int $action Should give context to what is taking place and be the same when nonce was created.
1249 * @return bool Whether the nonce check passed or failed.
1251 function wp_verify_nonce($nonce, $action = -1) {
1252 $user = wp_get_current_user();
1253 $uid = (int) $user->ID;
1255 $uid = apply_filters( 'nonce_user_logged_out', $uid, $action );
1257 $i = wp_nonce_tick();
1259 // Nonce generated 0-12 hours ago
1260 if ( substr(wp_hash($i . $action . $uid, 'nonce'), -12, 10) == $nonce )
1262 // Nonce generated 12-24 hours ago
1263 if ( substr(wp_hash(($i - 1) . $action . $uid, 'nonce'), -12, 10) == $nonce )
1270 if ( !function_exists('wp_create_nonce') ) :
1272 * Creates a random, one time use token.
1276 * @param string|int $action Scalar value to add context to the nonce.
1277 * @return string The one use form token
1279 function wp_create_nonce($action = -1) {
1280 $user = wp_get_current_user();
1281 $uid = (int) $user->ID;
1283 $uid = apply_filters( 'nonce_user_logged_out', $uid, $action );
1285 $i = wp_nonce_tick();
1287 return substr(wp_hash($i . $action . $uid, 'nonce'), -12, 10);
1291 if ( !function_exists('wp_salt') ) :
1293 * Get salt to add to hashes.
1295 * Salts are created using secret keys. Secret keys are located in two places:
1296 * in the database and in the wp-config.php file. The secret key in the database
1297 * is randomly generated and will be appended to the secret keys in wp-config.php.
1299 * The secret keys in wp-config.php should be updated to strong, random keys to maximize
1300 * security. Below is an example of how the secret key constants are defined.
1301 * Do not paste this example directly into wp-config.php. Instead, have a
1302 * {@link https://api.wordpress.org/secret-key/1.1/salt/ secret key created} just
1306 * define('AUTH_KEY', ' Xakm<o xQy rw4EMsLKM-?!T+,PFF})H4lzcW57AF0U@N@< >M%G4Yt>f`z]MON');
1307 * define('SECURE_AUTH_KEY', 'LzJ}op]mr|6+![P}Ak:uNdJCJZd>(Hx.-Mh#Tz)pCIU#uGEnfFz|f ;;eU%/U^O~');
1308 * define('LOGGED_IN_KEY', '|i|Ux`9<p-h$aFf(qnT:sDO:D1P^wZ$$/Ra@miTJi9G;ddp_<q}6H1)o|a +&JCM');
1309 * define('NONCE_KEY', '%:R{[P|,s.KuMltH5}cI;/k<Gx~j!f0I)m_sIyu+&NJZ)-iO>z7X>QYR0Z_XnZ@|');
1310 * define('AUTH_SALT', 'eZyT)-Naw]F8CwA*VaW#q*|.)g@o}||wf~@C-YSt}(dh_r6EbI#A,y|nU2{B#JBW');
1311 * define('SECURE_AUTH_SALT', '!=oLUTXh,QW=H `}`L|9/^4-3 STz},T(w}W<I`.JjPi)<Bmf1v,HpGe}T1:Xt7n');
1312 * define('LOGGED_IN_SALT', '+XSqHc;@Q*K_b|Z?NC[3H!!EONbh.n<+=uKR:>*c(u`g~EJBf#8u#R{mUEZrozmm');
1313 * define('NONCE_SALT', 'h`GXHhD>SLWVfg1(1(N{;.V!MoE(SfbA_ksP@&`+AycHcAV$+?@3q+rxV{%^VyKT');
1316 * Salting passwords helps against tools which has stored hashed values of
1317 * common dictionary strings. The added values makes it harder to crack.
1321 * @link https://api.wordpress.org/secret-key/1.1/salt/ Create secrets for wp-config.php
1323 * @param string $scheme Authentication scheme (auth, secure_auth, logged_in, nonce)
1324 * @return string Salt value
1326 function wp_salt( $scheme = 'auth' ) {
1327 static $cached_salts = array();
1328 if ( isset( $cached_salts[ $scheme ] ) )
1329 return apply_filters( 'salt', $cached_salts[ $scheme ], $scheme );
1331 static $duplicated_keys;
1332 if ( null === $duplicated_keys ) {
1333 $duplicated_keys = array( 'put your unique phrase here' => true );
1334 foreach ( array( 'AUTH', 'SECURE_AUTH', 'LOGGED_IN', 'NONCE', 'SECRET' ) as $first ) {
1335 foreach ( array( 'KEY', 'SALT' ) as $second ) {
1336 if ( ! defined( "{$first}_{$second}" ) )
1338 $value = constant( "{$first}_{$second}" );
1339 $duplicated_keys[ $value ] = isset( $duplicated_keys[ $value ] );
1345 if ( defined( 'SECRET_KEY' ) && SECRET_KEY && empty( $duplicated_keys[ SECRET_KEY ] ) )
1347 if ( 'auth' == $scheme && defined( 'SECRET_SALT' ) && SECRET_SALT && empty( $duplicated_keys[ SECRET_SALT ] ) )
1348 $salt = SECRET_SALT;
1350 if ( in_array( $scheme, array( 'auth', 'secure_auth', 'logged_in', 'nonce' ) ) ) {
1351 foreach ( array( 'key', 'salt' ) as $type ) {
1352 $const = strtoupper( "{$scheme}_{$type}" );
1353 if ( defined( $const ) && constant( $const ) && empty( $duplicated_keys[ constant( $const ) ] ) ) {
1354 $$type = constant( $const );
1355 } elseif ( ! $$type ) {
1356 $$type = get_site_option( "{$scheme}_{$type}" );
1358 $$type = wp_generate_password( 64, true, true );
1359 update_site_option( "{$scheme}_{$type}", $$type );
1365 $key = get_site_option( 'secret_key' );
1367 $key = wp_generate_password( 64, true, true );
1368 update_site_option( 'secret_key', $key );
1371 $salt = hash_hmac( 'md5', $scheme, $key );
1374 $cached_salts[ $scheme ] = $key . $salt;
1375 return apply_filters( 'salt', $cached_salts[ $scheme ], $scheme );
1379 if ( !function_exists('wp_hash') ) :
1381 * Get hash of given string.
1384 * @uses wp_salt() Get WordPress salt
1386 * @param string $data Plain text to hash
1387 * @return string Hash of $data
1389 function wp_hash($data, $scheme = 'auth') {
1390 $salt = wp_salt($scheme);
1392 return hash_hmac('md5', $data, $salt);
1396 if ( !function_exists('wp_hash_password') ) :
1398 * Create a hash (encrypt) of a plain text password.
1400 * For integration with other applications, this function can be overwritten to
1401 * instead use the other package password checking algorithm.
1404 * @global object $wp_hasher PHPass object
1405 * @uses PasswordHash::HashPassword
1407 * @param string $password Plain text user password to hash
1408 * @return string The hash string of the password
1410 function wp_hash_password($password) {
1413 if ( empty($wp_hasher) ) {
1414 require_once( ABSPATH . 'wp-includes/class-phpass.php');
1415 // By default, use the portable hash from phpass
1416 $wp_hasher = new PasswordHash(8, true);
1419 return $wp_hasher->HashPassword($password);
1423 if ( !function_exists('wp_check_password') ) :
1425 * Checks the plaintext password against the encrypted Password.
1427 * Maintains compatibility between old version and the new cookie authentication
1428 * protocol using PHPass library. The $hash parameter is the encrypted password
1429 * and the function compares the plain text password when encrypted similarly
1430 * against the already encrypted password to see if they match.
1432 * For integration with other applications, this function can be overwritten to
1433 * instead use the other package password checking algorithm.
1436 * @global object $wp_hasher PHPass object used for checking the password
1437 * against the $hash + $password
1438 * @uses PasswordHash::CheckPassword
1440 * @param string $password Plaintext user's password
1441 * @param string $hash Hash of the user's password to check against.
1442 * @return bool False, if the $password does not match the hashed password
1444 function wp_check_password($password, $hash, $user_id = '') {
1447 // If the hash is still md5...
1448 if ( strlen($hash) <= 32 ) {
1449 $check = ( $hash == md5($password) );
1450 if ( $check && $user_id ) {
1451 // Rehash using new hash.
1452 wp_set_password($password, $user_id);
1453 $hash = wp_hash_password($password);
1456 return apply_filters('check_password', $check, $password, $hash, $user_id);
1459 // If the stored hash is longer than an MD5, presume the
1460 // new style phpass portable hash.
1461 if ( empty($wp_hasher) ) {
1462 require_once( ABSPATH . 'wp-includes/class-phpass.php');
1463 // By default, use the portable hash from phpass
1464 $wp_hasher = new PasswordHash(8, true);
1467 $check = $wp_hasher->CheckPassword($password, $hash);
1469 return apply_filters('check_password', $check, $password, $hash, $user_id);
1473 if ( !function_exists('wp_generate_password') ) :
1475 * Generates a random password drawn from the defined set of characters.
1479 * @param int $length The length of password to generate
1480 * @param bool $special_chars Whether to include standard special characters. Default true.
1481 * @param bool $extra_special_chars Whether to include other special characters. Used when
1482 * generating secret keys and salts. Default false.
1483 * @return string The random password
1485 function wp_generate_password( $length = 12, $special_chars = true, $extra_special_chars = false ) {
1486 $chars = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789';
1487 if ( $special_chars )
1488 $chars .= '!@#$%^&*()';
1489 if ( $extra_special_chars )
1490 $chars .= '-_ []{}<>~`+=,.;:/?|';
1493 for ( $i = 0; $i < $length; $i++ ) {
1494 $password .= substr($chars, wp_rand(0, strlen($chars) - 1), 1);
1497 // random_password filter was previously in random_password function which was deprecated
1498 return apply_filters('random_password', $password);
1502 if ( !function_exists('wp_rand') ) :
1504 * Generates a random number
1508 * @param int $min Lower limit for the generated number
1509 * @param int $max Upper limit for the generated number
1510 * @return int A random number between min and max
1512 function wp_rand( $min = 0, $max = 0 ) {
1515 // Reset $rnd_value after 14 uses
1516 // 32(md5) + 40(sha1) + 40(sha1) / 8 = 14 random numbers from $rnd_value
1517 if ( strlen($rnd_value) < 8 ) {
1518 if ( defined( 'WP_SETUP_CONFIG' ) )
1521 $seed = get_transient('random_seed');
1522 $rnd_value = md5( uniqid(microtime() . mt_rand(), true ) . $seed );
1523 $rnd_value .= sha1($rnd_value);
1524 $rnd_value .= sha1($rnd_value . $seed);
1525 $seed = md5($seed . $rnd_value);
1526 if ( ! defined( 'WP_SETUP_CONFIG' ) )
1527 set_transient('random_seed', $seed);
1530 // Take the first 8 digits for our value
1531 $value = substr($rnd_value, 0, 8);
1533 // Strip the first eight, leaving the remainder for the next call to wp_rand().
1534 $rnd_value = substr($rnd_value, 8);
1536 $value = abs(hexdec($value));
1538 // Some misconfigured 32bit environments (Entropy PHP, for example) truncate integers larger than PHP_INT_MAX to PHP_INT_MAX rather than overflowing them to floats.
1539 $max_random_number = 3000000000 === 2147483647 ? (float) "4294967295" : 4294967295; // 4294967295 = 0xffffffff
1541 // Reduce the value to be within the min - max range
1543 $value = $min + ( $max - $min + 1 ) * $value / ( $max_random_number + 1 );
1545 return abs(intval($value));
1549 if ( !function_exists('wp_set_password') ) :
1551 * Updates the user's password with a new encrypted one.
1553 * For integration with other applications, this function can be overwritten to
1554 * instead use the other package password checking algorithm.
1557 * @uses $wpdb WordPress database object for queries
1558 * @uses wp_hash_password() Used to encrypt the user's password before passing to the database
1560 * @param string $password The plaintext new user password
1561 * @param int $user_id User ID
1563 function wp_set_password( $password, $user_id ) {
1566 $hash = wp_hash_password($password);
1567 $wpdb->update($wpdb->users, array('user_pass' => $hash, 'user_activation_key' => ''), array('ID' => $user_id) );
1569 wp_cache_delete($user_id, 'users');
1573 if ( !function_exists( 'get_avatar' ) ) :
1575 * Retrieve the avatar for a user who provided a user ID or email address.
1578 * @param int|string|object $id_or_email A user ID, email address, or comment object
1579 * @param int $size Size of the avatar image
1580 * @param string $default URL to a default image to use if no avatar is available
1581 * @param string $alt Alternative text to use in image tag. Defaults to blank
1582 * @return string <img> tag for the user's avatar
1584 function get_avatar( $id_or_email, $size = '96', $default = '', $alt = false ) {
1585 if ( ! get_option('show_avatars') )
1588 if ( false === $alt)
1591 $safe_alt = esc_attr( $alt );
1593 if ( !is_numeric($size) )
1597 if ( is_numeric($id_or_email) ) {
1598 $id = (int) $id_or_email;
1599 $user = get_userdata($id);
1601 $email = $user->user_email;
1602 } elseif ( is_object($id_or_email) ) {
1603 // No avatar for pingbacks or trackbacks
1604 $allowed_comment_types = apply_filters( 'get_avatar_comment_types', array( 'comment' ) );
1605 if ( ! empty( $id_or_email->comment_type ) && ! in_array( $id_or_email->comment_type, (array) $allowed_comment_types ) )
1608 if ( !empty($id_or_email->user_id) ) {
1609 $id = (int) $id_or_email->user_id;
1610 $user = get_userdata($id);
1612 $email = $user->user_email;
1613 } elseif ( !empty($id_or_email->comment_author_email) ) {
1614 $email = $id_or_email->comment_author_email;
1617 $email = $id_or_email;
1620 if ( empty($default) ) {
1621 $avatar_default = get_option('avatar_default');
1622 if ( empty($avatar_default) )
1623 $default = 'mystery';
1625 $default = $avatar_default;
1628 if ( !empty($email) )
1629 $email_hash = md5( strtolower( trim( $email ) ) );
1632 $host = 'https://secure.gravatar.com';
1634 if ( !empty($email) )
1635 $host = sprintf( "http://%d.gravatar.com", ( hexdec( $email_hash[0] ) % 2 ) );
1637 $host = 'http://0.gravatar.com';
1640 if ( 'mystery' == $default )
1641 $default = "$host/avatar/ad516503a11cd5ca435acc9bb6523536?s={$size}"; // ad516503a11cd5ca435acc9bb6523536 == md5('unknown@gravatar.com')
1642 elseif ( 'blank' == $default )
1643 $default = $email ? 'blank' : includes_url( 'images/blank.gif' );
1644 elseif ( !empty($email) && 'gravatar_default' == $default )
1646 elseif ( 'gravatar_default' == $default )
1647 $default = "$host/avatar/?s={$size}";
1648 elseif ( empty($email) )
1649 $default = "$host/avatar/?d=$default&s={$size}";
1650 elseif ( strpos($default, 'http://') === 0 )
1651 $default = add_query_arg( 's', $size, $default );
1653 if ( !empty($email) ) {
1654 $out = "$host/avatar/";
1655 $out .= $email_hash;
1656 $out .= '?s='.$size;
1657 $out .= '&d=' . urlencode( $default );
1659 $rating = get_option('avatar_rating');
1660 if ( !empty( $rating ) )
1661 $out .= "&r={$rating}";
1663 $avatar = "<img alt='{$safe_alt}' src='{$out}' class='avatar avatar-{$size} photo' height='{$size}' width='{$size}' />";
1665 $avatar = "<img alt='{$safe_alt}' src='{$default}' class='avatar avatar-{$size} photo avatar-default' height='{$size}' width='{$size}' />";
1668 return apply_filters('get_avatar', $avatar, $id_or_email, $size, $default, $alt);
1672 if ( !function_exists( 'wp_text_diff' ) ) :
1674 * Displays a human readable HTML representation of the difference between two strings.
1676 * The Diff is available for getting the changes between versions. The output is
1677 * HTML, so the primary use is for displaying the changes. If the two strings
1678 * are equivalent, then an empty string will be returned.
1680 * The arguments supported and can be changed are listed below.
1682 * 'title' : Default is an empty string. Titles the diff in a manner compatible
1684 * 'title_left' : Default is an empty string. Change the HTML to the left of the
1686 * 'title_right' : Default is an empty string. Change the HTML to the right of
1690 * @see wp_parse_args() Used to change defaults to user defined settings.
1692 * @uses WP_Text_Diff_Renderer_Table
1694 * @param string $left_string "old" (left) version of string
1695 * @param string $right_string "new" (right) version of string
1696 * @param string|array $args Optional. Change 'title', 'title_left', and 'title_right' defaults.
1697 * @return string Empty string if strings are equivalent or HTML with differences.
1699 function wp_text_diff( $left_string, $right_string, $args = null ) {
1700 $defaults = array( 'title' => '', 'title_left' => '', 'title_right' => '' );
1701 $args = wp_parse_args( $args, $defaults );
1703 if ( !class_exists( 'WP_Text_Diff_Renderer_Table' ) )
1704 require( ABSPATH . WPINC . '/wp-diff.php' );
1706 $left_string = normalize_whitespace($left_string);
1707 $right_string = normalize_whitespace($right_string);
1709 $left_lines = explode("\n", $left_string);
1710 $right_lines = explode("\n", $right_string);
1712 $text_diff = new Text_Diff($left_lines, $right_lines);
1713 $renderer = new WP_Text_Diff_Renderer_Table();
1714 $diff = $renderer->render($text_diff);
1719 $r = "<table class='diff'>\n";
1720 $r .= "<col class='ltype' /><col class='content' /><col class='ltype' /><col class='content' />";
1722 if ( $args['title'] || $args['title_left'] || $args['title_right'] )
1724 if ( $args['title'] )
1725 $r .= "<tr class='diff-title'><th colspan='4'>$args[title]</th></tr>\n";
1726 if ( $args['title_left'] || $args['title_right'] ) {
1727 $r .= "<tr class='diff-sub-title'>\n";
1728 $r .= "\t<td></td><th>$args[title_left]</th>\n";
1729 $r .= "\t<td></td><th>$args[title_right]</th>\n";
1732 if ( $args['title'] || $args['title_left'] || $args['title_right'] )
1735 $r .= "<tbody>\n$diff\n</tbody>\n";