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.
22 * @param int $id User ID
23 * @param string $name User's username
24 * @return WP_User Current user User object
26 function wp_set_current_user($id, $name = '') {
29 if ( isset( $current_user ) && ( $current_user instanceof WP_User ) && ( $id == $current_user->ID ) )
32 $current_user = new WP_User( $id, $name );
34 setup_userdata( $current_user->ID );
37 * Fires after the current user is set.
41 do_action( 'set_current_user' );
47 if ( !function_exists('wp_get_current_user') ) :
49 * Retrieve the current user object.
53 * @return WP_User Current user WP_User object
55 function wp_get_current_user() {
58 get_currentuserinfo();
64 if ( !function_exists('get_currentuserinfo') ) :
66 * Populate global variables with information about the currently logged in user.
68 * Will set the current user, if the current user is not set. The current user
69 * will be set to the logged-in person. If no user is logged-in, then it will
70 * set the current user to 0, which is invalid and won't have any permissions.
74 * @uses $current_user Checks if the current user is set
75 * @uses wp_validate_auth_cookie() Retrieves current logged in user.
77 * @return bool|null False on XML-RPC Request and invalid auth cookie. Null when current user set.
79 function get_currentuserinfo() {
82 if ( ! empty( $current_user ) ) {
83 if ( $current_user instanceof WP_User )
86 // Upgrade stdClass to WP_User
87 if ( is_object( $current_user ) && isset( $current_user->ID ) ) {
88 $cur_id = $current_user->ID;
90 wp_set_current_user( $cur_id );
94 // $current_user has a junk value. Force to WP_User with ID 0.
96 wp_set_current_user( 0 );
100 if ( defined('XMLRPC_REQUEST') && XMLRPC_REQUEST ) {
101 wp_set_current_user( 0 );
106 * Filter the current user.
108 * The default filters use this to determine the current user from the
109 * request's cookies, if available.
111 * Returning a value of false will effectively short-circuit setting
116 * @param int|bool $user_id User ID if one has been determined, false otherwise.
118 $user_id = apply_filters( 'determine_current_user', false );
120 wp_set_current_user( 0 );
124 wp_set_current_user( $user_id );
128 if ( !function_exists('get_userdata') ) :
130 * Retrieve user info by user ID.
134 * @param int $user_id User ID
135 * @return WP_User|bool WP_User object on success, false on failure.
137 function get_userdata( $user_id ) {
138 return get_user_by( 'id', $user_id );
142 if ( !function_exists('get_user_by') ) :
144 * Retrieve user info by a given field
148 * @param string $field The field to retrieve the user with. id | slug | email | login
149 * @param int|string $value A value for $field. A user ID, slug, email address, or login name.
150 * @return WP_User|bool WP_User object on success, false on failure.
152 function get_user_by( $field, $value ) {
153 $userdata = WP_User::get_data_by( $field, $value );
159 $user->init( $userdata );
165 if ( !function_exists('cache_users') ) :
167 * Retrieve info for user lists to prevent multiple queries by get_userdata()
171 * @param array $user_ids User ID numbers list
173 function cache_users( $user_ids ) {
176 $clean = _get_non_cached_ids( $user_ids, 'users' );
178 if ( empty( $clean ) )
181 $list = implode( ',', $clean );
183 $users = $wpdb->get_results( "SELECT * FROM $wpdb->users WHERE ID IN ($list)" );
186 foreach ( $users as $user ) {
187 update_user_caches( $user );
190 update_meta_cache( 'user', $ids );
194 if ( !function_exists( 'wp_mail' ) ) :
196 * Send mail, similar to PHP's mail
198 * A true return value does not automatically mean that the user received the
199 * email successfully. It just only means that the method used was able to
200 * process the request without any errors.
202 * Using the two 'wp_mail_from' and 'wp_mail_from_name' hooks allow from
203 * creating a from address like 'Name <email@address.com>' when both are set. If
204 * just 'wp_mail_from' is set, then just the email address will be used with no
207 * The default content type is 'text/plain' which does not allow using HTML.
208 * However, you can set the content type of the email by using the
209 * 'wp_mail_content_type' filter.
211 * The default charset is based on the charset used on the blog. The charset can
212 * be set using the 'wp_mail_charset' filter.
218 * @param string|array $to Array or comma-separated list of email addresses to send message.
219 * @param string $subject Email subject
220 * @param string $message Message contents
221 * @param string|array $headers Optional. Additional headers.
222 * @param string|array $attachments Optional. Files to attach.
223 * @return bool Whether the email contents were sent successfully.
225 function wp_mail( $to, $subject, $message, $headers = '', $attachments = array() ) {
226 // Compact the input, apply the filters, and extract them back out
229 * Filter the wp_mail() arguments.
233 * @param array $args A compacted array of wp_mail() arguments, including the "to" email,
234 * subject, message, headers, and attachments values.
236 extract( apply_filters( 'wp_mail', compact( 'to', 'subject', 'message', 'headers', 'attachments' ) ) );
238 if ( !is_array($attachments) )
239 $attachments = explode( "\n", str_replace( "\r\n", "\n", $attachments ) );
243 // (Re)create it, if it's gone missing
244 if ( !is_object( $phpmailer ) || !is_a( $phpmailer, 'PHPMailer' ) ) {
245 require_once ABSPATH . WPINC . '/class-phpmailer.php';
246 require_once ABSPATH . WPINC . '/class-smtp.php';
247 $phpmailer = new PHPMailer( true );
251 if ( empty( $headers ) ) {
254 if ( !is_array( $headers ) ) {
255 // Explode the headers out, so this function can take both
256 // string headers and an array of headers.
257 $tempheaders = explode( "\n", str_replace( "\r\n", "\n", $headers ) );
259 $tempheaders = $headers;
265 // If it's actually got contents
266 if ( !empty( $tempheaders ) ) {
267 // Iterate through the raw headers
268 foreach ( (array) $tempheaders as $header ) {
269 if ( strpos($header, ':') === false ) {
270 if ( false !== stripos( $header, 'boundary=' ) ) {
271 $parts = preg_split('/boundary=/i', trim( $header ) );
272 $boundary = trim( str_replace( array( "'", '"' ), '', $parts[1] ) );
277 list( $name, $content ) = explode( ':', trim( $header ), 2 );
280 $name = trim( $name );
281 $content = trim( $content );
283 switch ( strtolower( $name ) ) {
284 // Mainly for legacy -- process a From: header if it's there
286 if ( strpos($content, '<' ) !== false ) {
287 // So... making my life hard again?
288 $from_name = substr( $content, 0, strpos( $content, '<' ) - 1 );
289 $from_name = str_replace( '"', '', $from_name );
290 $from_name = trim( $from_name );
292 $from_email = substr( $content, strpos( $content, '<' ) + 1 );
293 $from_email = str_replace( '>', '', $from_email );
294 $from_email = trim( $from_email );
296 $from_email = trim( $content );
300 if ( strpos( $content, ';' ) !== false ) {
301 list( $type, $charset ) = explode( ';', $content );
302 $content_type = trim( $type );
303 if ( false !== stripos( $charset, 'charset=' ) ) {
304 $charset = trim( str_replace( array( 'charset=', '"' ), '', $charset ) );
305 } elseif ( false !== stripos( $charset, 'boundary=' ) ) {
306 $boundary = trim( str_replace( array( 'BOUNDARY=', 'boundary=', '"' ), '', $charset ) );
310 $content_type = trim( $content );
314 $cc = array_merge( (array) $cc, explode( ',', $content ) );
317 $bcc = array_merge( (array) $bcc, explode( ',', $content ) );
320 // Add it to our grand headers array
321 $headers[trim( $name )] = trim( $content );
328 // Empty out the values that may be set
329 $phpmailer->ClearAllRecipients();
330 $phpmailer->ClearAttachments();
331 $phpmailer->ClearCustomHeaders();
332 $phpmailer->ClearReplyTos();
334 // From email and name
335 // If we don't have a name from the input headers
336 if ( !isset( $from_name ) )
337 $from_name = 'WordPress';
339 /* If we don't have an email from the input headers default to wordpress@$sitename
340 * Some hosts will block outgoing mail from this address if it doesn't exist but
341 * there's no easy alternative. Defaulting to admin_email might appear to be another
342 * option but some hosts may refuse to relay mail from an unknown domain. See
343 * http://trac.wordpress.org/ticket/5007.
346 if ( !isset( $from_email ) ) {
347 // Get the site domain and get rid of www.
348 $sitename = strtolower( $_SERVER['SERVER_NAME'] );
349 if ( substr( $sitename, 0, 4 ) == 'www.' ) {
350 $sitename = substr( $sitename, 4 );
353 $from_email = 'wordpress@' . $sitename;
357 * Filter the email address to send from.
361 * @param string $from_email Email address to send from.
363 $phpmailer->From = apply_filters( 'wp_mail_from', $from_email );
366 * Filter the name to associate with the "from" email address.
370 * @param string $from_name Name associated with the "from" email address.
372 $phpmailer->FromName = apply_filters( 'wp_mail_from_name', $from_name );
374 // Set destination addresses
375 if ( !is_array( $to ) )
376 $to = explode( ',', $to );
378 foreach ( (array) $to as $recipient ) {
380 // Break $recipient into name and address parts if in the format "Foo <bar@baz.com>"
381 $recipient_name = '';
382 if( preg_match( '/(.*)<(.+)>/', $recipient, $matches ) ) {
383 if ( count( $matches ) == 3 ) {
384 $recipient_name = $matches[1];
385 $recipient = $matches[2];
388 $phpmailer->AddAddress( $recipient, $recipient_name);
389 } catch ( phpmailerException $e ) {
394 // Set mail's subject and body
395 $phpmailer->Subject = $subject;
396 $phpmailer->Body = $message;
398 // Add any CC and BCC recipients
399 if ( !empty( $cc ) ) {
400 foreach ( (array) $cc as $recipient ) {
402 // Break $recipient into name and address parts if in the format "Foo <bar@baz.com>"
403 $recipient_name = '';
404 if( preg_match( '/(.*)<(.+)>/', $recipient, $matches ) ) {
405 if ( count( $matches ) == 3 ) {
406 $recipient_name = $matches[1];
407 $recipient = $matches[2];
410 $phpmailer->AddCc( $recipient, $recipient_name );
411 } catch ( phpmailerException $e ) {
417 if ( !empty( $bcc ) ) {
418 foreach ( (array) $bcc as $recipient) {
420 // Break $recipient into name and address parts if in the format "Foo <bar@baz.com>"
421 $recipient_name = '';
422 if( preg_match( '/(.*)<(.+)>/', $recipient, $matches ) ) {
423 if ( count( $matches ) == 3 ) {
424 $recipient_name = $matches[1];
425 $recipient = $matches[2];
428 $phpmailer->AddBcc( $recipient, $recipient_name );
429 } catch ( phpmailerException $e ) {
435 // Set to use PHP's mail()
436 $phpmailer->IsMail();
438 // Set Content-Type and charset
439 // If we don't have a content-type from the input headers
440 if ( !isset( $content_type ) )
441 $content_type = 'text/plain';
444 * Filter the wp_mail() content type.
448 * @param string $content_type Default wp_mail() content type.
450 $content_type = apply_filters( 'wp_mail_content_type', $content_type );
452 $phpmailer->ContentType = $content_type;
454 // Set whether it's plaintext, depending on $content_type
455 if ( 'text/html' == $content_type )
456 $phpmailer->IsHTML( true );
458 // If we don't have a charset from the input headers
459 if ( !isset( $charset ) )
460 $charset = get_bloginfo( 'charset' );
462 // Set the content-type and charset
465 * Filter the default wp_mail() charset.
469 * @param string $charset Default email charset.
471 $phpmailer->CharSet = apply_filters( 'wp_mail_charset', $charset );
473 // Set custom headers
474 if ( !empty( $headers ) ) {
475 foreach( (array) $headers as $name => $content ) {
476 $phpmailer->AddCustomHeader( sprintf( '%1$s: %2$s', $name, $content ) );
479 if ( false !== stripos( $content_type, 'multipart' ) && ! empty($boundary) )
480 $phpmailer->AddCustomHeader( sprintf( "Content-Type: %s;\n\t boundary=\"%s\"", $content_type, $boundary ) );
483 if ( !empty( $attachments ) ) {
484 foreach ( $attachments as $attachment ) {
486 $phpmailer->AddAttachment($attachment);
487 } catch ( phpmailerException $e ) {
494 * Fires after PHPMailer is initialized.
498 * @param PHPMailer &$phpmailer The PHPMailer instance, passed by reference.
500 do_action_ref_array( 'phpmailer_init', array( &$phpmailer ) );
504 return $phpmailer->Send();
505 } catch ( phpmailerException $e ) {
511 if ( !function_exists('wp_authenticate') ) :
513 * Checks a user's login information and logs them in if it checks out.
517 * @param string $username User's username
518 * @param string $password User's password
519 * @return WP_User|WP_Error WP_User object if login successful, otherwise WP_Error object.
521 function wp_authenticate($username, $password) {
522 $username = sanitize_user($username);
523 $password = trim($password);
526 * Filter the user to authenticate.
528 * If a non-null value is passed, the filter will effectively short-circuit
529 * authentication, returning an error instead.
533 * @param null|WP_User $user User to authenticate.
534 * @param string $username User login.
535 * @param string $password User password
537 $user = apply_filters( 'authenticate', null, $username, $password );
539 if ( $user == null ) {
540 // TODO what should the error message be? (Or would these even happen?)
541 // Only needed if all authentication handlers fail to return anything.
542 $user = new WP_Error('authentication_failed', __('<strong>ERROR</strong>: Invalid username or incorrect password.'));
545 $ignore_codes = array('empty_username', 'empty_password');
547 if (is_wp_error($user) && !in_array($user->get_error_code(), $ignore_codes) ) {
549 * Fires after a user login has failed.
553 * @param string $username User login.
555 do_action( 'wp_login_failed', $username );
562 if ( !function_exists('wp_logout') ) :
564 * Log the current user out.
568 function wp_logout() {
569 wp_clear_auth_cookie();
572 * Fires after a user is logged-out.
576 do_action( 'wp_logout' );
580 if ( !function_exists('wp_validate_auth_cookie') ) :
582 * Validates authentication cookie.
584 * The checks include making sure that the authentication cookie is set and
585 * pulling in the contents (if $cookie is not used).
587 * Makes sure the cookie is not expired. Verifies the hash in cookie is what is
588 * should be and compares the two.
592 * @param string $cookie Optional. If used, will validate contents instead of cookie's
593 * @param string $scheme Optional. The cookie scheme to use: auth, secure_auth, or logged_in
594 * @return bool|int False if invalid cookie, User ID if valid.
596 function wp_validate_auth_cookie($cookie = '', $scheme = '') {
597 if ( ! $cookie_elements = wp_parse_auth_cookie($cookie, $scheme) ) {
599 * Fires if an authentication cookie is malformed.
603 * @param string $cookie Malformed auth cookie.
604 * @param string $scheme Authentication scheme. Values include 'auth', 'secure_auth',
607 do_action( 'auth_cookie_malformed', $cookie, $scheme );
611 extract($cookie_elements, EXTR_OVERWRITE);
613 $expired = $expiration;
615 // Allow a grace period for POST and AJAX requests
616 if ( defined('DOING_AJAX') || 'POST' == $_SERVER['REQUEST_METHOD'] )
617 $expired += HOUR_IN_SECONDS;
619 // Quick check to see if an honest cookie has expired
620 if ( $expired < time() ) {
622 * Fires once an authentication cookie has expired.
626 * @param array $cookie_elements An array of data for the authentication cookie.
628 do_action( 'auth_cookie_expired', $cookie_elements );
632 $user = get_user_by('login', $username);
635 * Fires if a bad username is entered in the user authentication process.
639 * @param array $cookie_elements An array of data for the authentication cookie.
641 do_action( 'auth_cookie_bad_username', $cookie_elements );
645 $pass_frag = substr($user->user_pass, 8, 4);
647 $key = wp_hash($username . $pass_frag . '|' . $expiration, $scheme);
648 $hash = hash_hmac('md5', $username . '|' . $expiration, $key);
650 if ( hash_hmac( 'md5', $hmac, $key ) !== hash_hmac( 'md5', $hash, $key ) ) {
652 * Fires if a bad authentication cookie hash is encountered.
656 * @param array $cookie_elements An array of data for the authentication cookie.
658 do_action( 'auth_cookie_bad_hash', $cookie_elements );
662 if ( $expiration < time() ) // AJAX/POST grace period set above
663 $GLOBALS['login_grace_period'] = 1;
666 * Fires once an authentication cookie has been validated.
670 * @param array $cookie_elements An array of data for the authentication cookie.
671 * @param WP_User $user User object.
673 do_action( 'auth_cookie_valid', $cookie_elements, $user );
679 if ( !function_exists('wp_generate_auth_cookie') ) :
681 * Generate authentication cookie contents.
685 * @param int $user_id User ID
686 * @param int $expiration Cookie expiration in seconds
687 * @param string $scheme Optional. The cookie scheme to use: auth, secure_auth, or logged_in
688 * @return string Authentication cookie contents
690 function wp_generate_auth_cookie($user_id, $expiration, $scheme = 'auth') {
691 $user = get_userdata($user_id);
693 $pass_frag = substr($user->user_pass, 8, 4);
695 $key = wp_hash($user->user_login . $pass_frag . '|' . $expiration, $scheme);
696 $hash = hash_hmac('md5', $user->user_login . '|' . $expiration, $key);
698 $cookie = $user->user_login . '|' . $expiration . '|' . $hash;
701 * Filter the authentication cookie.
705 * @param string $cookie Authentication cookie.
706 * @param int $user_id User ID.
707 * @param int $expiration Authentication cookie expiration in seconds.
708 * @param string $scheme Cookie scheme used. Accepts 'auth', 'secure_auth', or 'logged_in'.
710 return apply_filters( 'auth_cookie', $cookie, $user_id, $expiration, $scheme );
714 if ( !function_exists('wp_parse_auth_cookie') ) :
716 * Parse a cookie into its components
720 * @param string $cookie
721 * @param string $scheme Optional. The cookie scheme to use: auth, secure_auth, or logged_in
722 * @return array Authentication cookie components
724 function wp_parse_auth_cookie($cookie = '', $scheme = '') {
725 if ( empty($cookie) ) {
728 $cookie_name = AUTH_COOKIE;
731 $cookie_name = SECURE_AUTH_COOKIE;
734 $cookie_name = LOGGED_IN_COOKIE;
738 $cookie_name = SECURE_AUTH_COOKIE;
739 $scheme = 'secure_auth';
741 $cookie_name = AUTH_COOKIE;
746 if ( empty($_COOKIE[$cookie_name]) )
748 $cookie = $_COOKIE[$cookie_name];
751 $cookie_elements = explode('|', $cookie);
752 if ( count($cookie_elements) != 3 )
755 list($username, $expiration, $hmac) = $cookie_elements;
757 return compact('username', 'expiration', 'hmac', 'scheme');
761 if ( !function_exists('wp_set_auth_cookie') ) :
763 * Sets the authentication cookies based on user ID.
765 * The $remember parameter increases the time that the cookie will be kept. The
766 * default the cookie is kept without remembering is two days. When $remember is
767 * set, the cookies will be kept for 14 days or two weeks.
771 * @param int $user_id User ID
772 * @param bool $remember Whether to remember the user
774 function wp_set_auth_cookie($user_id, $remember = false, $secure = '') {
777 * Filter the duration of the authentication cookie expiration period.
781 * @param int $length Duration of the expiration period in seconds.
782 * @param int $user_id User ID.
783 * @param bool $remember Whether to remember the user login. Default false.
785 $expiration = time() + apply_filters( 'auth_cookie_expiration', 14 * DAY_IN_SECONDS, $user_id, $remember );
788 * Ensure the browser will continue to send the cookie after the expiration time is reached.
789 * Needed for the login grace period in wp_validate_auth_cookie().
791 $expire = $expiration + ( 12 * HOUR_IN_SECONDS );
793 /** This filter is documented in wp-includes/pluggable.php */
794 $expiration = time() + apply_filters( 'auth_cookie_expiration', 2 * DAY_IN_SECONDS, $user_id, $remember );
798 if ( '' === $secure )
802 * Filter whether the connection is secure.
806 * @param bool $secure Whether the connection is secure.
807 * @param int $user_id User ID.
809 $secure = apply_filters( 'secure_auth_cookie', $secure, $user_id );
812 * Filter whether to use a secure cookie when logged-in.
816 * @param bool $cookie Whether to use a secure cookie when logged-in.
817 * @param int $user_id User ID.
818 * @param bool $secure Whether the connection is secure.
820 $secure_logged_in_cookie = apply_filters( 'secure_logged_in_cookie', false, $user_id, $secure );
823 $auth_cookie_name = SECURE_AUTH_COOKIE;
824 $scheme = 'secure_auth';
826 $auth_cookie_name = AUTH_COOKIE;
830 $auth_cookie = wp_generate_auth_cookie($user_id, $expiration, $scheme);
831 $logged_in_cookie = wp_generate_auth_cookie($user_id, $expiration, 'logged_in');
834 * Fires immediately before the authentication cookie is set.
838 * @param string $auth_cookie Authentication cookie.
839 * @param int $expire Login grace period in seconds. Default 43,200 seconds, or 12 hours.
840 * @param int $expiration Duration in seconds the authentication cookie should be valid.
841 * Default 1,209,600 seconds, or 14 days.
842 * @param int $user_id User ID.
843 * @param string $scheme Authentication scheme. Values include 'auth', 'secure_auth', or 'logged_in'.
845 do_action( 'set_auth_cookie', $auth_cookie, $expire, $expiration, $user_id, $scheme );
848 * Fires immediately before the secure authentication cookie is set.
852 * @param string $logged_in_cookie The logged-in cookie.
853 * @param int $expire Login grace period in seconds. Default 43,200 seconds, or 12 hours.
854 * @param int $expiration Duration in seconds the authentication cookie should be valid.
855 * Default 1,209,600 seconds, or 14 days.
856 * @param int $user_id User ID.
857 * @param string $scheme Authentication scheme. Default 'logged_in'.
859 do_action( 'set_logged_in_cookie', $logged_in_cookie, $expire, $expiration, $user_id, 'logged_in' );
861 setcookie($auth_cookie_name, $auth_cookie, $expire, PLUGINS_COOKIE_PATH, COOKIE_DOMAIN, $secure, true);
862 setcookie($auth_cookie_name, $auth_cookie, $expire, ADMIN_COOKIE_PATH, COOKIE_DOMAIN, $secure, true);
863 setcookie(LOGGED_IN_COOKIE, $logged_in_cookie, $expire, COOKIEPATH, COOKIE_DOMAIN, $secure_logged_in_cookie, true);
864 if ( COOKIEPATH != SITECOOKIEPATH )
865 setcookie(LOGGED_IN_COOKIE, $logged_in_cookie, $expire, SITECOOKIEPATH, COOKIE_DOMAIN, $secure_logged_in_cookie, true);
869 if ( !function_exists('wp_clear_auth_cookie') ) :
871 * Removes all of the cookies associated with authentication.
875 function wp_clear_auth_cookie() {
877 * Fires just before the authentication cookies are cleared.
881 do_action( 'clear_auth_cookie' );
883 setcookie( AUTH_COOKIE, ' ', time() - YEAR_IN_SECONDS, ADMIN_COOKIE_PATH, COOKIE_DOMAIN );
884 setcookie( SECURE_AUTH_COOKIE, ' ', time() - YEAR_IN_SECONDS, ADMIN_COOKIE_PATH, COOKIE_DOMAIN );
885 setcookie( AUTH_COOKIE, ' ', time() - YEAR_IN_SECONDS, PLUGINS_COOKIE_PATH, COOKIE_DOMAIN );
886 setcookie( SECURE_AUTH_COOKIE, ' ', time() - YEAR_IN_SECONDS, PLUGINS_COOKIE_PATH, COOKIE_DOMAIN );
887 setcookie( LOGGED_IN_COOKIE, ' ', time() - YEAR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN );
888 setcookie( LOGGED_IN_COOKIE, ' ', time() - YEAR_IN_SECONDS, SITECOOKIEPATH, COOKIE_DOMAIN );
891 setcookie( AUTH_COOKIE, ' ', time() - YEAR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN );
892 setcookie( AUTH_COOKIE, ' ', time() - YEAR_IN_SECONDS, SITECOOKIEPATH, COOKIE_DOMAIN );
893 setcookie( SECURE_AUTH_COOKIE, ' ', time() - YEAR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN );
894 setcookie( SECURE_AUTH_COOKIE, ' ', time() - YEAR_IN_SECONDS, SITECOOKIEPATH, COOKIE_DOMAIN );
896 // Even older cookies
897 setcookie( USER_COOKIE, ' ', time() - YEAR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN );
898 setcookie( PASS_COOKIE, ' ', time() - YEAR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN );
899 setcookie( USER_COOKIE, ' ', time() - YEAR_IN_SECONDS, SITECOOKIEPATH, COOKIE_DOMAIN );
900 setcookie( PASS_COOKIE, ' ', time() - YEAR_IN_SECONDS, SITECOOKIEPATH, COOKIE_DOMAIN );
904 if ( !function_exists('is_user_logged_in') ) :
906 * Checks if the current visitor is a logged in user.
910 * @return bool True if user is logged in, false if not logged in.
912 function is_user_logged_in() {
913 $user = wp_get_current_user();
915 if ( ! $user->exists() )
922 if ( !function_exists('auth_redirect') ) :
924 * Checks if a user is logged in, if not it redirects them to the login page.
928 function auth_redirect() {
929 // Checks if a user is logged in, if not redirects them to the login page
931 $secure = ( is_ssl() || force_ssl_admin() );
934 * Filter whether to use a secure authentication redirect.
938 * @param bool $secure Whether to use a secure authentication redirect. Default false.
940 $secure = apply_filters( 'secure_auth_redirect', $secure );
942 // If https is required and request is http, redirect
943 if ( $secure && !is_ssl() && false !== strpos($_SERVER['REQUEST_URI'], 'wp-admin') ) {
944 if ( 0 === strpos( $_SERVER['REQUEST_URI'], 'http' ) ) {
945 wp_redirect( set_url_scheme( $_SERVER['REQUEST_URI'], 'https' ) );
948 wp_redirect( 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );
953 if ( is_user_admin() ) {
954 $scheme = 'logged_in';
957 * Filter the authentication redirect scheme.
961 * @param string $scheme Authentication redirect scheme. Default empty.
963 $scheme = apply_filters( 'auth_redirect_scheme', '' );
966 if ( $user_id = wp_validate_auth_cookie( '', $scheme) ) {
968 * Fires before the authentication redirect.
972 * @param int $user_id User ID.
974 do_action( 'auth_redirect', $user_id );
976 // If the user wants ssl but the session is not ssl, redirect.
977 if ( !$secure && get_user_option('use_ssl', $user_id) && false !== strpos($_SERVER['REQUEST_URI'], 'wp-admin') ) {
978 if ( 0 === strpos( $_SERVER['REQUEST_URI'], 'http' ) ) {
979 wp_redirect( set_url_scheme( $_SERVER['REQUEST_URI'], 'https' ) );
982 wp_redirect( 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );
987 return; // The cookie is good so we're done
990 // The cookie is no good so force login
993 $redirect = ( strpos( $_SERVER['REQUEST_URI'], '/options.php' ) && wp_get_referer() ) ? wp_get_referer() : set_url_scheme( 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );
995 $login_url = wp_login_url($redirect, true);
997 wp_redirect($login_url);
1002 if ( !function_exists('check_admin_referer') ) :
1004 * Makes sure that a user was referred from another admin page.
1006 * To avoid security exploits.
1010 * @param string $action Action nonce
1011 * @param string $query_arg where to look for nonce in $_REQUEST (since 2.5)
1013 function check_admin_referer($action = -1, $query_arg = '_wpnonce') {
1014 if ( -1 == $action )
1015 _doing_it_wrong( __FUNCTION__, __( 'You should specify a nonce action to be verified by using the first parameter.' ), '3.2' );
1017 $adminurl = strtolower(admin_url());
1018 $referer = strtolower(wp_get_referer());
1019 $result = isset($_REQUEST[$query_arg]) ? wp_verify_nonce($_REQUEST[$query_arg], $action) : false;
1020 if ( !$result && !(-1 == $action && strpos($referer, $adminurl) === 0) ) {
1021 wp_nonce_ays($action);
1026 * Fires once the admin request has been validated or not.
1030 * @param string $action The nonce action.
1031 * @param bool $result Whether the admin request nonce was validated.
1033 do_action( 'check_admin_referer', $action, $result );
1038 if ( !function_exists('check_ajax_referer') ) :
1040 * Verifies the AJAX request to prevent processing requests external of the blog.
1044 * @param string $action Action nonce
1045 * @param string $query_arg where to look for nonce in $_REQUEST (since 2.5)
1047 function check_ajax_referer( $action = -1, $query_arg = false, $die = true ) {
1050 if ( $query_arg && isset( $_REQUEST[ $query_arg ] ) )
1051 $nonce = $_REQUEST[ $query_arg ];
1052 elseif ( isset( $_REQUEST['_ajax_nonce'] ) )
1053 $nonce = $_REQUEST['_ajax_nonce'];
1054 elseif ( isset( $_REQUEST['_wpnonce'] ) )
1055 $nonce = $_REQUEST['_wpnonce'];
1057 $result = wp_verify_nonce( $nonce, $action );
1059 if ( $die && false == $result ) {
1060 if ( defined( 'DOING_AJAX' ) && DOING_AJAX )
1067 * Fires once the AJAX request has been validated or not.
1071 * @param string $action The AJAX nonce action.
1072 * @param bool $result Whether the AJAX request nonce was validated.
1074 do_action( 'check_ajax_referer', $action, $result );
1080 if ( !function_exists('wp_redirect') ) :
1082 * Redirects to another page.
1086 * @param string $location The path to redirect to.
1087 * @param int $status Status code to use.
1088 * @return bool False if $location is not provided, true otherwise.
1090 function wp_redirect($location, $status = 302) {
1094 * Filter the redirect location.
1098 * @param string $location The path to redirect to.
1099 * @param int $status Status code to use.
1101 $location = apply_filters( 'wp_redirect', $location, $status );
1104 * Filter the redirect status code.
1108 * @param int $status Status code to use.
1109 * @param string $location The path to redirect to.
1111 $status = apply_filters( 'wp_redirect_status', $status, $location );
1116 $location = wp_sanitize_redirect($location);
1118 if ( !$is_IIS && php_sapi_name() != 'cgi-fcgi' )
1119 status_header($status); // This causes problems on IIS and some FastCGI setups
1121 header("Location: $location", true, $status);
1127 if ( !function_exists('wp_sanitize_redirect') ) :
1129 * Sanitizes a URL for use in a redirect.
1133 * @return string redirect-sanitized URL
1135 function wp_sanitize_redirect($location) {
1136 $location = preg_replace('|[^a-z0-9-~+_.?#=&;,/:%!]|i', '', $location);
1137 $location = wp_kses_no_null($location);
1139 // remove %0d and %0a from location
1140 $strip = array('%0d', '%0a', '%0D', '%0A');
1141 $location = _deep_replace($strip, $location);
1146 if ( !function_exists('wp_safe_redirect') ) :
1148 * Performs a safe (local) redirect, using wp_redirect().
1150 * Checks whether the $location is using an allowed host, if it has an absolute
1151 * path. A plugin can therefore set or remove allowed host(s) to or from the
1154 * If the host is not allowed, then the redirect is to wp-admin on the siteurl
1155 * instead. This prevents malicious redirects which redirect to another host,
1156 * but only used in a few places.
1160 * @uses wp_validate_redirect() To validate the redirect is to an allowed host.
1162 * @return void Does not return anything
1164 function wp_safe_redirect($location, $status = 302) {
1166 // Need to look at the URL the way it will end up in wp_redirect()
1167 $location = wp_sanitize_redirect($location);
1169 $location = wp_validate_redirect($location, admin_url());
1171 wp_redirect($location, $status);
1175 if ( !function_exists('wp_validate_redirect') ) :
1177 * Validates a URL for use in a redirect.
1179 * Checks whether the $location is using an allowed host, if it has an absolute
1180 * path. A plugin can therefore set or remove allowed host(s) to or from the
1183 * If the host is not allowed, then the redirect is to $default supplied
1187 * @param string $location The redirect to validate
1188 * @param string $default The value to return if $location is not allowed
1189 * @return string redirect-sanitized URL
1191 function wp_validate_redirect($location, $default = '') {
1192 $location = trim( $location );
1193 // browsers will assume 'http' is your protocol, and will obey a redirect to a URL starting with '//'
1194 if ( substr($location, 0, 2) == '//' )
1195 $location = 'http:' . $location;
1197 // In php 5 parse_url may fail if the URL query part contains http://, bug #38143
1198 $test = ( $cut = strpos($location, '?') ) ? substr( $location, 0, $cut ) : $location;
1200 $lp = parse_url($test);
1202 // Give up if malformed URL
1203 if ( false === $lp )
1206 // Allow only http and https schemes. No data:, etc.
1207 if ( isset($lp['scheme']) && !('http' == $lp['scheme'] || 'https' == $lp['scheme']) )
1210 // 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.
1211 if ( isset($lp['scheme']) && !isset($lp['host']) )
1214 $wpp = parse_url(home_url());
1217 * Filter the whitelist of hosts to redirect to.
1221 * @param array $hosts An array of allowed hosts.
1222 * @param bool|string $host The parsed host; empty if not isset.
1224 $allowed_hosts = (array) apply_filters( 'allowed_redirect_hosts', array($wpp['host']), isset($lp['host']) ? $lp['host'] : '' );
1226 if ( isset($lp['host']) && ( !in_array($lp['host'], $allowed_hosts) && $lp['host'] != strtolower($wpp['host'])) )
1227 $location = $default;
1233 if ( ! function_exists('wp_notify_postauthor') ) :
1235 * Notify an author (and/or others) of a comment/trackback/pingback on a post.
1239 * @param int $comment_id Comment ID
1240 * @param string $deprecated Not used
1241 * @return bool True on completion. False if no email addresses were specified.
1243 function wp_notify_postauthor( $comment_id, $deprecated = null ) {
1244 if ( null !== $deprecated ) {
1245 _deprecated_argument( __FUNCTION__, '3.8' );
1248 $comment = get_comment( $comment_id );
1249 if ( empty( $comment ) )
1252 $post = get_post( $comment->comment_post_ID );
1253 $author = get_userdata( $post->post_author );
1255 // Who to notify? By default, just the post author, but others can be added.
1258 $emails[] = $author->user_email;
1262 * Filter the list of email addresses to receive a comment notification.
1264 * By default, only post authors are notified of comments. This filter allows
1265 * others to be added.
1269 * @param array $emails An array of email addresses to receive a comment notification.
1270 * @param int $comment_id The comment ID.
1272 $emails = apply_filters( 'comment_notification_recipients', $emails, $comment_id );
1273 $emails = array_filter( $emails );
1275 // If there are no addresses to send the comment to, bail.
1276 if ( ! count( $emails ) ) {
1280 // Facilitate unsetting below without knowing the keys.
1281 $emails = array_flip( $emails );
1284 * Filter whether to notify comment authors of their comments on their own posts.
1286 * By default, comment authors aren't notified of their comments on their own
1287 * posts. This filter allows you to override that.
1291 * @param bool $notify Whether to notify the post author of their own comment.
1293 * @param int $comment_id The comment ID.
1295 $notify_author = apply_filters( 'comment_notification_notify_author', false, $comment_id );
1297 // The comment was left by the author
1298 if ( $author && ! $notify_author && $comment->user_id == $post->post_author ) {
1299 unset( $emails[ $author->user_email ] );
1302 // The author moderated a comment on their own post
1303 if ( $author && ! $notify_author && $post->post_author == get_current_user_id() ) {
1304 unset( $emails[ $author->user_email ] );
1307 // The post author is no longer a member of the blog
1308 if ( $author && ! $notify_author && ! user_can( $post->post_author, 'read_post', $post->ID ) ) {
1309 unset( $emails[ $author->user_email ] );
1312 // If there's no email to send the comment to, bail, otherwise flip array back around for use below
1313 if ( ! count( $emails ) ) {
1316 $emails = array_flip( $emails );
1319 $comment_author_domain = @gethostbyaddr($comment->comment_author_IP);
1321 // The blogname option is escaped with esc_html on the way into the database in sanitize_option
1322 // we want to reverse this for the plain text arena of emails.
1323 $blogname = wp_specialchars_decode(get_option('blogname'), ENT_QUOTES);
1325 switch ( $comment->comment_type ) {
1327 $notify_message = sprintf( __( 'New trackback on your post "%s"' ), $post->post_title ) . "\r\n";
1328 /* translators: 1: website name, 2: author IP, 3: author domain */
1329 $notify_message .= sprintf( __('Website: %1$s (IP: %2$s , %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
1330 $notify_message .= sprintf( __('URL : %s'), $comment->comment_author_url ) . "\r\n";
1331 $notify_message .= __('Excerpt: ') . "\r\n" . $comment->comment_content . "\r\n\r\n";
1332 $notify_message .= __('You can see all trackbacks on this post here: ') . "\r\n";
1333 /* translators: 1: blog name, 2: post title */
1334 $subject = sprintf( __('[%1$s] Trackback: "%2$s"'), $blogname, $post->post_title );
1337 $notify_message = sprintf( __( 'New pingback on your post "%s"' ), $post->post_title ) . "\r\n";
1338 /* translators: 1: comment author, 2: author IP, 3: author domain */
1339 $notify_message .= sprintf( __('Website: %1$s (IP: %2$s , %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
1340 $notify_message .= sprintf( __('URL : %s'), $comment->comment_author_url ) . "\r\n";
1341 $notify_message .= __('Excerpt: ') . "\r\n" . sprintf('[...] %s [...]', $comment->comment_content ) . "\r\n\r\n";
1342 $notify_message .= __('You can see all pingbacks on this post here: ') . "\r\n";
1343 /* translators: 1: blog name, 2: post title */
1344 $subject = sprintf( __('[%1$s] Pingback: "%2$s"'), $blogname, $post->post_title );
1346 default: // Comments
1347 $notify_message = sprintf( __( 'New comment on your post "%s"' ), $post->post_title ) . "\r\n";
1348 /* translators: 1: comment author, 2: author IP, 3: author domain */
1349 $notify_message .= sprintf( __('Author : %1$s (IP: %2$s , %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
1350 $notify_message .= sprintf( __('E-mail : %s'), $comment->comment_author_email ) . "\r\n";
1351 $notify_message .= sprintf( __('URL : %s'), $comment->comment_author_url ) . "\r\n";
1352 $notify_message .= sprintf( __('Whois : http://whois.arin.net/rest/ip/%s'), $comment->comment_author_IP ) . "\r\n";
1353 $notify_message .= __('Comment: ') . "\r\n" . $comment->comment_content . "\r\n\r\n";
1354 $notify_message .= __('You can see all comments on this post here: ') . "\r\n";
1355 /* translators: 1: blog name, 2: post title */
1356 $subject = sprintf( __('[%1$s] Comment: "%2$s"'), $blogname, $post->post_title );
1359 $notify_message .= get_permalink($comment->comment_post_ID) . "#comments\r\n\r\n";
1360 $notify_message .= sprintf( __('Permalink: %s'), get_comment_link( $comment_id ) ) . "\r\n";
1362 if ( user_can( $post->post_author, 'edit_comment', $comment_id ) ) {
1363 if ( EMPTY_TRASH_DAYS )
1364 $notify_message .= sprintf( __('Trash it: %s'), admin_url("comment.php?action=trash&c=$comment_id") ) . "\r\n";
1366 $notify_message .= sprintf( __('Delete it: %s'), admin_url("comment.php?action=delete&c=$comment_id") ) . "\r\n";
1367 $notify_message .= sprintf( __('Spam it: %s'), admin_url("comment.php?action=spam&c=$comment_id") ) . "\r\n";
1370 $wp_email = 'wordpress@' . preg_replace('#^www\.#', '', strtolower($_SERVER['SERVER_NAME']));
1372 if ( '' == $comment->comment_author ) {
1373 $from = "From: \"$blogname\" <$wp_email>";
1374 if ( '' != $comment->comment_author_email )
1375 $reply_to = "Reply-To: $comment->comment_author_email";
1377 $from = "From: \"$comment->comment_author\" <$wp_email>";
1378 if ( '' != $comment->comment_author_email )
1379 $reply_to = "Reply-To: \"$comment->comment_author_email\" <$comment->comment_author_email>";
1382 $message_headers = "$from\n"
1383 . "Content-Type: text/plain; charset=\"" . get_option('blog_charset') . "\"\n";
1385 if ( isset($reply_to) )
1386 $message_headers .= $reply_to . "\n";
1389 * Filter the comment notification email text.
1393 * @param string $notify_message The comment notification email text.
1394 * @param int $comment_id Comment ID.
1396 $notify_message = apply_filters( 'comment_notification_text', $notify_message, $comment_id );
1399 * Filter the comment notification email subject.
1403 * @param string $subject The comment notification email subject.
1404 * @param int $comment_id Comment ID.
1406 $subject = apply_filters( 'comment_notification_subject', $subject, $comment_id );
1409 * Filter the comment notification email headers.
1413 * @param string $message_headers Headers for the comment notification email.
1414 * @param int $comment_id Comment ID.
1416 $message_headers = apply_filters( 'comment_notification_headers', $message_headers, $comment_id );
1418 foreach ( $emails as $email ) {
1419 @wp_mail( $email, wp_specialchars_decode( $subject ), $notify_message, $message_headers );
1426 if ( !function_exists('wp_notify_moderator') ) :
1428 * Notifies the moderator of the blog about a new comment that is awaiting approval.
1434 * @param int $comment_id Comment ID
1435 * @return bool Always returns true
1437 function wp_notify_moderator($comment_id) {
1440 if ( 0 == get_option( 'moderation_notify' ) )
1443 $comment = get_comment($comment_id);
1444 $post = get_post($comment->comment_post_ID);
1445 $user = get_userdata( $post->post_author );
1446 // Send to the administration and to the post author if the author can modify the comment.
1447 $emails = array( get_option( 'admin_email' ) );
1448 if ( user_can( $user->ID, 'edit_comment', $comment_id ) && ! empty( $user->user_email ) ) {
1449 if ( 0 !== strcasecmp( $user->user_email, get_option( 'admin_email' ) ) )
1450 $emails[] = $user->user_email;
1453 $comment_author_domain = @gethostbyaddr($comment->comment_author_IP);
1454 $comments_waiting = $wpdb->get_var("SELECT count(comment_ID) FROM $wpdb->comments WHERE comment_approved = '0'");
1456 // The blogname option is escaped with esc_html on the way into the database in sanitize_option
1457 // we want to reverse this for the plain text arena of emails.
1458 $blogname = wp_specialchars_decode(get_option('blogname'), ENT_QUOTES);
1460 switch ( $comment->comment_type ) {
1462 $notify_message = sprintf( __('A new trackback on the post "%s" is waiting for your approval'), $post->post_title ) . "\r\n";
1463 $notify_message .= get_permalink($comment->comment_post_ID) . "\r\n\r\n";
1464 $notify_message .= sprintf( __('Website : %1$s (IP: %2$s , %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
1465 $notify_message .= sprintf( __('URL : %s'), $comment->comment_author_url ) . "\r\n";
1466 $notify_message .= __('Trackback excerpt: ') . "\r\n" . $comment->comment_content . "\r\n\r\n";
1469 $notify_message = sprintf( __('A new pingback on the post "%s" is waiting for your approval'), $post->post_title ) . "\r\n";
1470 $notify_message .= get_permalink($comment->comment_post_ID) . "\r\n\r\n";
1471 $notify_message .= sprintf( __('Website : %1$s (IP: %2$s , %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
1472 $notify_message .= sprintf( __('URL : %s'), $comment->comment_author_url ) . "\r\n";
1473 $notify_message .= __('Pingback excerpt: ') . "\r\n" . $comment->comment_content . "\r\n\r\n";
1475 default: // Comments
1476 $notify_message = sprintf( __('A new comment on the post "%s" is waiting for your approval'), $post->post_title ) . "\r\n";
1477 $notify_message .= get_permalink($comment->comment_post_ID) . "\r\n\r\n";
1478 $notify_message .= sprintf( __('Author : %1$s (IP: %2$s , %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
1479 $notify_message .= sprintf( __('E-mail : %s'), $comment->comment_author_email ) . "\r\n";
1480 $notify_message .= sprintf( __('URL : %s'), $comment->comment_author_url ) . "\r\n";
1481 $notify_message .= sprintf( __('Whois : http://whois.arin.net/rest/ip/%s'), $comment->comment_author_IP ) . "\r\n";
1482 $notify_message .= __('Comment: ') . "\r\n" . $comment->comment_content . "\r\n\r\n";
1486 $notify_message .= sprintf( __('Approve it: %s'), admin_url("comment.php?action=approve&c=$comment_id") ) . "\r\n";
1487 if ( EMPTY_TRASH_DAYS )
1488 $notify_message .= sprintf( __('Trash it: %s'), admin_url("comment.php?action=trash&c=$comment_id") ) . "\r\n";
1490 $notify_message .= sprintf( __('Delete it: %s'), admin_url("comment.php?action=delete&c=$comment_id") ) . "\r\n";
1491 $notify_message .= sprintf( __('Spam it: %s'), admin_url("comment.php?action=spam&c=$comment_id") ) . "\r\n";
1493 $notify_message .= sprintf( _n('Currently %s comment is waiting for approval. Please visit the moderation panel:',
1494 'Currently %s comments are waiting for approval. Please visit the moderation panel:', $comments_waiting), number_format_i18n($comments_waiting) ) . "\r\n";
1495 $notify_message .= admin_url("edit-comments.php?comment_status=moderated") . "\r\n";
1497 $subject = sprintf( __('[%1$s] Please moderate: "%2$s"'), $blogname, $post->post_title );
1498 $message_headers = '';
1501 * Filter the list of recipients for comment moderation emails.
1505 * @param array $emails List of email addresses to notify for comment moderation.
1506 * @param int $comment_id Comment ID.
1508 $emails = apply_filters( 'comment_moderation_recipients', $emails, $comment_id );
1511 * Filter the comment moderation email text.
1515 * @param string $notify_message Text of the comment moderation email.
1516 * @param int $comment_id Comment ID.
1518 $notify_message = apply_filters( 'comment_moderation_text', $notify_message, $comment_id );
1521 * Filter the comment moderation email subject.
1525 * @param string $subject Subject of the comment moderation email.
1526 * @param int $comment_id Comment ID.
1528 $subject = apply_filters( 'comment_moderation_subject', $subject, $comment_id );
1531 * Filter the comment moderation email headers.
1535 * @param string $message_headers Headers for the comment moderation email.
1536 * @param int $comment_id Comment ID.
1538 $message_headers = apply_filters( 'comment_moderation_headers', $message_headers, $comment_id );
1540 foreach ( $emails as $email ) {
1541 @wp_mail( $email, wp_specialchars_decode( $subject ), $notify_message, $message_headers );
1548 if ( !function_exists('wp_password_change_notification') ) :
1550 * Notify the blog admin of a user changing password, normally via email.
1554 * @param object $user User Object
1556 function wp_password_change_notification(&$user) {
1557 // send a copy of password change notification to the admin
1558 // but check to see if it's the admin whose password we're changing, and skip this
1559 if ( 0 !== strcasecmp( $user->user_email, get_option( 'admin_email' ) ) ) {
1560 $message = sprintf(__('Password Lost and Changed for user: %s'), $user->user_login) . "\r\n";
1561 // The blogname option is escaped with esc_html on the way into the database in sanitize_option
1562 // we want to reverse this for the plain text arena of emails.
1563 $blogname = wp_specialchars_decode(get_option('blogname'), ENT_QUOTES);
1564 wp_mail(get_option('admin_email'), sprintf(__('[%s] Password Lost/Changed'), $blogname), $message);
1569 if ( !function_exists('wp_new_user_notification') ) :
1571 * Email login credentials to a newly-registered user.
1573 * A new user registration notification is also sent to admin email.
1577 * @param int $user_id User ID.
1578 * @param string $plaintext_pass Optional. The user's plaintext password. Default empty.
1580 function wp_new_user_notification($user_id, $plaintext_pass = '') {
1581 $user = get_userdata( $user_id );
1583 // The blogname option is escaped with esc_html on the way into the database in sanitize_option
1584 // we want to reverse this for the plain text arena of emails.
1585 $blogname = wp_specialchars_decode(get_option('blogname'), ENT_QUOTES);
1587 $message = sprintf(__('New user registration on your site %s:'), $blogname) . "\r\n\r\n";
1588 $message .= sprintf(__('Username: %s'), $user->user_login) . "\r\n\r\n";
1589 $message .= sprintf(__('E-mail: %s'), $user->user_email) . "\r\n";
1591 @wp_mail(get_option('admin_email'), sprintf(__('[%s] New User Registration'), $blogname), $message);
1593 if ( empty($plaintext_pass) )
1596 $message = sprintf(__('Username: %s'), $user->user_login) . "\r\n";
1597 $message .= sprintf(__('Password: %s'), $plaintext_pass) . "\r\n";
1598 $message .= wp_login_url() . "\r\n";
1600 wp_mail($user->user_email, sprintf(__('[%s] Your username and password'), $blogname), $message);
1605 if ( !function_exists('wp_nonce_tick') ) :
1607 * Get the time-dependent variable for nonce creation.
1609 * A nonce has a lifespan of two ticks. Nonces in their second tick may be
1610 * updated, e.g. by autosave.
1616 function wp_nonce_tick() {
1618 * Filter the lifespan of nonces in seconds.
1622 * @param int $lifespan Lifespan of nonces in seconds. Default 86,400 seconds, or one day.
1624 $nonce_life = apply_filters( 'nonce_life', DAY_IN_SECONDS );
1626 return ceil(time() / ( $nonce_life / 2 ));
1630 if ( !function_exists('wp_verify_nonce') ) :
1632 * Verify that correct nonce was used with time limit.
1634 * The user is given an amount of time to use the token, so therefore, since the
1635 * UID and $action remain the same, the independent variable is the time.
1639 * @param string $nonce Nonce that was used in the form to verify
1640 * @param string|int $action Should give context to what is taking place and be the same when nonce was created.
1641 * @return bool Whether the nonce check passed or failed.
1643 function wp_verify_nonce($nonce, $action = -1) {
1644 $user = wp_get_current_user();
1645 $uid = (int) $user->ID;
1648 * Filter whether the user who generated the nonce is logged out.
1652 * @param int $uid ID of the nonce-owning user.
1653 * @param string $action The nonce action.
1655 $uid = apply_filters( 'nonce_user_logged_out', $uid, $action );
1658 $i = wp_nonce_tick();
1660 // Nonce generated 0-12 hours ago
1661 if ( substr(wp_hash($i . $action . $uid, 'nonce'), -12, 10) === $nonce )
1663 // Nonce generated 12-24 hours ago
1664 if ( substr(wp_hash(($i - 1) . $action . $uid, 'nonce'), -12, 10) === $nonce )
1671 if ( !function_exists('wp_create_nonce') ) :
1673 * Creates a random, one time use token.
1677 * @param string|int $action Scalar value to add context to the nonce.
1678 * @return string The one use form token
1680 function wp_create_nonce($action = -1) {
1681 $user = wp_get_current_user();
1682 $uid = (int) $user->ID;
1684 /** This filter is documented in wp-includes/pluggable.php */
1685 $uid = apply_filters( 'nonce_user_logged_out', $uid, $action );
1688 $i = wp_nonce_tick();
1690 return substr(wp_hash($i . $action . $uid, 'nonce'), -12, 10);
1694 if ( !function_exists('wp_salt') ) :
1696 * Get salt to add to hashes.
1698 * Salts are created using secret keys. Secret keys are located in two places:
1699 * in the database and in the wp-config.php file. The secret key in the database
1700 * is randomly generated and will be appended to the secret keys in wp-config.php.
1702 * The secret keys in wp-config.php should be updated to strong, random keys to maximize
1703 * security. Below is an example of how the secret key constants are defined.
1704 * Do not paste this example directly into wp-config.php. Instead, have a
1705 * {@link https://api.wordpress.org/secret-key/1.1/salt/ secret key created} just
1709 * define('AUTH_KEY', ' Xakm<o xQy rw4EMsLKM-?!T+,PFF})H4lzcW57AF0U@N@< >M%G4Yt>f`z]MON');
1710 * define('SECURE_AUTH_KEY', 'LzJ}op]mr|6+![P}Ak:uNdJCJZd>(Hx.-Mh#Tz)pCIU#uGEnfFz|f ;;eU%/U^O~');
1711 * define('LOGGED_IN_KEY', '|i|Ux`9<p-h$aFf(qnT:sDO:D1P^wZ$$/Ra@miTJi9G;ddp_<q}6H1)o|a +&JCM');
1712 * define('NONCE_KEY', '%:R{[P|,s.KuMltH5}cI;/k<Gx~j!f0I)m_sIyu+&NJZ)-iO>z7X>QYR0Z_XnZ@|');
1713 * define('AUTH_SALT', 'eZyT)-Naw]F8CwA*VaW#q*|.)g@o}||wf~@C-YSt}(dh_r6EbI#A,y|nU2{B#JBW');
1714 * define('SECURE_AUTH_SALT', '!=oLUTXh,QW=H `}`L|9/^4-3 STz},T(w}W<I`.JjPi)<Bmf1v,HpGe}T1:Xt7n');
1715 * define('LOGGED_IN_SALT', '+XSqHc;@Q*K_b|Z?NC[3H!!EONbh.n<+=uKR:>*c(u`g~EJBf#8u#R{mUEZrozmm');
1716 * define('NONCE_SALT', 'h`GXHhD>SLWVfg1(1(N{;.V!MoE(SfbA_ksP@&`+AycHcAV$+?@3q+rxV{%^VyKT');
1719 * Salting passwords helps against tools which has stored hashed values of
1720 * common dictionary strings. The added values makes it harder to crack.
1724 * @link https://api.wordpress.org/secret-key/1.1/salt/ Create secrets for wp-config.php
1726 * @param string $scheme Authentication scheme (auth, secure_auth, logged_in, nonce)
1727 * @return string Salt value
1729 function wp_salt( $scheme = 'auth' ) {
1730 static $cached_salts = array();
1731 if ( isset( $cached_salts[ $scheme ] ) ) {
1733 * Filter the WordPress salt.
1737 * @param string $cached_salt Cached salt for the given scheme.
1738 * @param string $scheme Authentication scheme. Values include 'auth',
1739 * 'secure_auth', 'logged_in', and 'nonce'.
1741 return apply_filters( 'salt', $cached_salts[ $scheme ], $scheme );
1744 static $duplicated_keys;
1745 if ( null === $duplicated_keys ) {
1746 $duplicated_keys = array( 'put your unique phrase here' => true );
1747 foreach ( array( 'AUTH', 'SECURE_AUTH', 'LOGGED_IN', 'NONCE', 'SECRET' ) as $first ) {
1748 foreach ( array( 'KEY', 'SALT' ) as $second ) {
1749 if ( ! defined( "{$first}_{$second}" ) )
1751 $value = constant( "{$first}_{$second}" );
1752 $duplicated_keys[ $value ] = isset( $duplicated_keys[ $value ] );
1758 if ( defined( 'SECRET_KEY' ) && SECRET_KEY && empty( $duplicated_keys[ SECRET_KEY ] ) )
1760 if ( 'auth' == $scheme && defined( 'SECRET_SALT' ) && SECRET_SALT && empty( $duplicated_keys[ SECRET_SALT ] ) )
1761 $salt = SECRET_SALT;
1763 if ( in_array( $scheme, array( 'auth', 'secure_auth', 'logged_in', 'nonce' ) ) ) {
1764 foreach ( array( 'key', 'salt' ) as $type ) {
1765 $const = strtoupper( "{$scheme}_{$type}" );
1766 if ( defined( $const ) && constant( $const ) && empty( $duplicated_keys[ constant( $const ) ] ) ) {
1767 $$type = constant( $const );
1768 } elseif ( ! $$type ) {
1769 $$type = get_site_option( "{$scheme}_{$type}" );
1771 $$type = wp_generate_password( 64, true, true );
1772 update_site_option( "{$scheme}_{$type}", $$type );
1778 $key = get_site_option( 'secret_key' );
1780 $key = wp_generate_password( 64, true, true );
1781 update_site_option( 'secret_key', $key );
1784 $salt = hash_hmac( 'md5', $scheme, $key );
1787 $cached_salts[ $scheme ] = $key . $salt;
1789 /** This filter is documented in wp-includes/pluggable.php */
1790 return apply_filters( 'salt', $cached_salts[ $scheme ], $scheme );
1794 if ( !function_exists('wp_hash') ) :
1796 * Get hash of given string.
1799 * @uses wp_salt() Get WordPress salt
1801 * @param string $data Plain text to hash
1802 * @return string Hash of $data
1804 function wp_hash($data, $scheme = 'auth') {
1805 $salt = wp_salt($scheme);
1807 return hash_hmac('md5', $data, $salt);
1811 if ( !function_exists('wp_hash_password') ) :
1813 * Create a hash (encrypt) of a plain text password.
1815 * For integration with other applications, this function can be overwritten to
1816 * instead use the other package password checking algorithm.
1820 * @global object $wp_hasher PHPass object
1821 * @uses PasswordHash::HashPassword
1823 * @param string $password Plain text user password to hash
1824 * @return string The hash string of the password
1826 function wp_hash_password($password) {
1829 if ( empty($wp_hasher) ) {
1830 require_once( ABSPATH . 'wp-includes/class-phpass.php');
1831 // By default, use the portable hash from phpass
1832 $wp_hasher = new PasswordHash(8, true);
1835 return $wp_hasher->HashPassword( trim( $password ) );
1839 if ( !function_exists('wp_check_password') ) :
1841 * Checks the plaintext password against the encrypted Password.
1843 * Maintains compatibility between old version and the new cookie authentication
1844 * protocol using PHPass library. The $hash parameter is the encrypted password
1845 * and the function compares the plain text password when encrypted similarly
1846 * against the already encrypted password to see if they match.
1848 * For integration with other applications, this function can be overwritten to
1849 * instead use the other package password checking algorithm.
1853 * @global object $wp_hasher PHPass object used for checking the password
1854 * against the $hash + $password
1855 * @uses PasswordHash::CheckPassword
1857 * @param string $password Plaintext user's password
1858 * @param string $hash Hash of the user's password to check against.
1859 * @return bool False, if the $password does not match the hashed password
1861 function wp_check_password($password, $hash, $user_id = '') {
1864 // If the hash is still md5...
1865 if ( strlen($hash) <= 32 ) {
1866 $check = ( $hash == md5($password) );
1867 if ( $check && $user_id ) {
1868 // Rehash using new hash.
1869 wp_set_password($password, $user_id);
1870 $hash = wp_hash_password($password);
1874 * Filter whether the plaintext password matches the encrypted password.
1878 * @param bool $check Whether the passwords match.
1879 * @param string $hash The hashed password.
1880 * @param int $user_id User ID.
1882 return apply_filters( 'check_password', $check, $password, $hash, $user_id );
1885 // If the stored hash is longer than an MD5, presume the
1886 // new style phpass portable hash.
1887 if ( empty($wp_hasher) ) {
1888 require_once( ABSPATH . 'wp-includes/class-phpass.php');
1889 // By default, use the portable hash from phpass
1890 $wp_hasher = new PasswordHash(8, true);
1893 $check = $wp_hasher->CheckPassword($password, $hash);
1895 /** This filter is documented in wp-includes/pluggable.php */
1896 return apply_filters( 'check_password', $check, $password, $hash, $user_id );
1900 if ( !function_exists('wp_generate_password') ) :
1902 * Generates a random password drawn from the defined set of characters.
1906 * @param int $length The length of password to generate
1907 * @param bool $special_chars Whether to include standard special characters. Default true.
1908 * @param bool $extra_special_chars Whether to include other special characters. Used when
1909 * generating secret keys and salts. Default false.
1910 * @return string The random password
1912 function wp_generate_password( $length = 12, $special_chars = true, $extra_special_chars = false ) {
1913 $chars = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789';
1914 if ( $special_chars )
1915 $chars .= '!@#$%^&*()';
1916 if ( $extra_special_chars )
1917 $chars .= '-_ []{}<>~`+=,.;:/?|';
1920 for ( $i = 0; $i < $length; $i++ ) {
1921 $password .= substr($chars, wp_rand(0, strlen($chars) - 1), 1);
1925 * Filter the randomly-generated password.
1929 * @param string $password The generated password.
1931 return apply_filters( 'random_password', $password );
1935 if ( !function_exists('wp_rand') ) :
1937 * Generates a random number
1941 * @param int $min Lower limit for the generated number
1942 * @param int $max Upper limit for the generated number
1943 * @return int A random number between min and max
1945 function wp_rand( $min = 0, $max = 0 ) {
1948 // Reset $rnd_value after 14 uses
1949 // 32(md5) + 40(sha1) + 40(sha1) / 8 = 14 random numbers from $rnd_value
1950 if ( strlen($rnd_value) < 8 ) {
1951 if ( defined( 'WP_SETUP_CONFIG' ) )
1954 $seed = get_transient('random_seed');
1955 $rnd_value = md5( uniqid(microtime() . mt_rand(), true ) . $seed );
1956 $rnd_value .= sha1($rnd_value);
1957 $rnd_value .= sha1($rnd_value . $seed);
1958 $seed = md5($seed . $rnd_value);
1959 if ( ! defined( 'WP_SETUP_CONFIG' ) )
1960 set_transient('random_seed', $seed);
1963 // Take the first 8 digits for our value
1964 $value = substr($rnd_value, 0, 8);
1966 // Strip the first eight, leaving the remainder for the next call to wp_rand().
1967 $rnd_value = substr($rnd_value, 8);
1969 $value = abs(hexdec($value));
1971 // 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.
1972 $max_random_number = 3000000000 === 2147483647 ? (float) "4294967295" : 4294967295; // 4294967295 = 0xffffffff
1974 // Reduce the value to be within the min - max range
1976 $value = $min + ( $max - $min + 1 ) * $value / ( $max_random_number + 1 );
1978 return abs(intval($value));
1982 if ( !function_exists('wp_set_password') ) :
1984 * Updates the user's password with a new encrypted one.
1986 * For integration with other applications, this function can be overwritten to
1987 * instead use the other package password checking algorithm.
1991 * @uses $wpdb WordPress database object for queries
1992 * @uses wp_hash_password() Used to encrypt the user's password before passing to the database
1994 * @param string $password The plaintext new user password
1995 * @param int $user_id User ID
1997 function wp_set_password( $password, $user_id ) {
2000 $hash = wp_hash_password( $password );
2001 $wpdb->update($wpdb->users, array('user_pass' => $hash, 'user_activation_key' => ''), array('ID' => $user_id) );
2003 wp_cache_delete($user_id, 'users');
2007 if ( !function_exists( 'get_avatar' ) ) :
2009 * Retrieve the avatar for a user who provided a user ID or email address.
2013 * @param int|string|object $id_or_email A user ID, email address, or comment object
2014 * @param int $size Size of the avatar image
2015 * @param string $default URL to a default image to use if no avatar is available
2016 * @param string $alt Alternative text to use in image tag. Defaults to blank
2017 * @return string <img> tag for the user's avatar
2019 function get_avatar( $id_or_email, $size = '96', $default = '', $alt = false ) {
2020 if ( ! get_option('show_avatars') )
2023 if ( false === $alt)
2026 $safe_alt = esc_attr( $alt );
2028 if ( !is_numeric($size) )
2032 if ( is_numeric($id_or_email) ) {
2033 $id = (int) $id_or_email;
2034 $user = get_userdata($id);
2036 $email = $user->user_email;
2037 } elseif ( is_object($id_or_email) ) {
2038 // No avatar for pingbacks or trackbacks
2041 * Filter the list of allowed comment types for retrieving avatars.
2045 * @param array $types An array of content types. Default only contains 'comment'.
2047 $allowed_comment_types = apply_filters( 'get_avatar_comment_types', array( 'comment' ) );
2048 if ( ! empty( $id_or_email->comment_type ) && ! in_array( $id_or_email->comment_type, (array) $allowed_comment_types ) )
2051 if ( ! empty( $id_or_email->user_id ) ) {
2052 $id = (int) $id_or_email->user_id;
2053 $user = get_userdata($id);
2055 $email = $user->user_email;
2058 if ( ! $email && ! empty( $id_or_email->comment_author_email ) )
2059 $email = $id_or_email->comment_author_email;
2061 $email = $id_or_email;
2064 if ( empty($default) ) {
2065 $avatar_default = get_option('avatar_default');
2066 if ( empty($avatar_default) )
2067 $default = 'mystery';
2069 $default = $avatar_default;
2072 if ( !empty($email) )
2073 $email_hash = md5( strtolower( trim( $email ) ) );
2076 $host = 'https://secure.gravatar.com';
2078 if ( !empty($email) )
2079 $host = sprintf( "http://%d.gravatar.com", ( hexdec( $email_hash[0] ) % 2 ) );
2081 $host = 'http://0.gravatar.com';
2084 if ( 'mystery' == $default )
2085 $default = "$host/avatar/ad516503a11cd5ca435acc9bb6523536?s={$size}"; // ad516503a11cd5ca435acc9bb6523536 == md5('unknown@gravatar.com')
2086 elseif ( 'blank' == $default )
2087 $default = $email ? 'blank' : includes_url( 'images/blank.gif' );
2088 elseif ( !empty($email) && 'gravatar_default' == $default )
2090 elseif ( 'gravatar_default' == $default )
2091 $default = "$host/avatar/?s={$size}";
2092 elseif ( empty($email) )
2093 $default = "$host/avatar/?d=$default&s={$size}";
2094 elseif ( strpos($default, 'http://') === 0 )
2095 $default = add_query_arg( 's', $size, $default );
2097 if ( !empty($email) ) {
2098 $out = "$host/avatar/";
2099 $out .= $email_hash;
2100 $out .= '?s='.$size;
2101 $out .= '&d=' . urlencode( $default );
2103 $rating = get_option('avatar_rating');
2104 if ( !empty( $rating ) )
2105 $out .= "&r={$rating}";
2107 $out = str_replace( '&', '&', esc_url( $out ) );
2108 $avatar = "<img alt='{$safe_alt}' src='{$out}' class='avatar avatar-{$size} photo' height='{$size}' width='{$size}' />";
2110 $avatar = "<img alt='{$safe_alt}' src='{$default}' class='avatar avatar-{$size} photo avatar-default' height='{$size}' width='{$size}' />";
2114 * Filter the avatar to retrieve.
2118 * @param string $avatar Image tag for the user's avatar.
2119 * @param int|object|string $id_or_email A user ID, email address, or comment object.
2120 * @param int $size Square avatar width and height in pixels to retrieve.
2121 * @param string $alt Alternative text to use in the avatar image tag.
2124 return apply_filters( 'get_avatar', $avatar, $id_or_email, $size, $default, $alt );
2128 if ( !function_exists( 'wp_text_diff' ) ) :
2130 * Displays a human readable HTML representation of the difference between two strings.
2132 * The Diff is available for getting the changes between versions. The output is
2133 * HTML, so the primary use is for displaying the changes. If the two strings
2134 * are equivalent, then an empty string will be returned.
2136 * The arguments supported and can be changed are listed below.
2138 * 'title' : Default is an empty string. Titles the diff in a manner compatible
2140 * 'title_left' : Default is an empty string. Change the HTML to the left of the
2142 * 'title_right' : Default is an empty string. Change the HTML to the right of
2147 * @see wp_parse_args() Used to change defaults to user defined settings.
2149 * @uses WP_Text_Diff_Renderer_Table
2151 * @param string $left_string "old" (left) version of string
2152 * @param string $right_string "new" (right) version of string
2153 * @param string|array $args Optional. Change 'title', 'title_left', and 'title_right' defaults.
2154 * @return string Empty string if strings are equivalent or HTML with differences.
2156 function wp_text_diff( $left_string, $right_string, $args = null ) {
2157 $defaults = array( 'title' => '', 'title_left' => '', 'title_right' => '' );
2158 $args = wp_parse_args( $args, $defaults );
2160 if ( !class_exists( 'WP_Text_Diff_Renderer_Table' ) )
2161 require( ABSPATH . WPINC . '/wp-diff.php' );
2163 $left_string = normalize_whitespace($left_string);
2164 $right_string = normalize_whitespace($right_string);
2166 $left_lines = explode("\n", $left_string);
2167 $right_lines = explode("\n", $right_string);
2168 $text_diff = new Text_Diff($left_lines, $right_lines);
2169 $renderer = new WP_Text_Diff_Renderer_Table( $args );
2170 $diff = $renderer->render($text_diff);
2175 $r = "<table class='diff'>\n";
2177 if ( ! empty( $args[ 'show_split_view' ] ) ) {
2178 $r .= "<col class='content diffsplit left' /><col class='content diffsplit middle' /><col class='content diffsplit right' />";
2180 $r .= "<col class='content' />";
2183 if ( $args['title'] || $args['title_left'] || $args['title_right'] )
2185 if ( $args['title'] )
2186 $r .= "<tr class='diff-title'><th colspan='4'>$args[title]</th></tr>\n";
2187 if ( $args['title_left'] || $args['title_right'] ) {
2188 $r .= "<tr class='diff-sub-title'>\n";
2189 $r .= "\t<td></td><th>$args[title_left]</th>\n";
2190 $r .= "\t<td></td><th>$args[title_right]</th>\n";
2193 if ( $args['title'] || $args['title_left'] || $args['title_right'] )
2196 $r .= "<tbody>\n$diff\n</tbody>\n";