wp-includes/pluggable.php

   1 <?php
   2 /**
   3  * These functions can be replaced via plugins. If plugins do not redefine these
   4  * functions, then these will be used instead.
   5  *
   6  * @package WordPress
   7  */
   8
   9 if ( !function_exists('wp_set_current_user') ) :
  10 /**
  11  * Changes the current user by ID or name.
  12  *
  13  * Set $id to null and specify a name if you do not know a user's ID.
  14  *
  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.
  18  *
  19  * @since 2.0.3
  20  * @global WP_User $current_user The current user object which holds the user data.
  21  *
  22  * @param int    $id   User ID
  23  * @param string $name User's username
  24  * @return WP_User Current user User object
  25  */
  26 function wp_set_current_user($id, $name = '') {
  27         global $current_user;
  28
  29         // If `$id` matches the user who's already current, there's nothing to do.
  30         if ( isset( $current_user )
  31                 && ( $current_user instanceof WP_User )
  32                 && ( $id == $current_user->ID )
  33                 && ( null !== $id )
  34         ) {
  35                 return $current_user;
  36         }
  37
  38         $current_user = new WP_User( $id, $name );
  39
  40         setup_userdata( $current_user->ID );
  41
  42         /**
  43          * Fires after the current user is set.
  44          *
  45          * @since 2.0.1
  46          */
  47         do_action( 'set_current_user' );
  48
  49         return $current_user;
  50 }
  51 endif;
  52
  53 if ( !function_exists('wp_get_current_user') ) :
  54 /**
  55  * Retrieve the current user object.
  56  *
  57  * Will set the current user, if the current user is not set. The current user
  58  * will be set to the logged-in person. If no user is logged-in, then it will
  59  * set the current user to 0, which is invalid and won't have any permissions.
  60  *
  61  * @since 2.0.3
  62  *
  63  * @see _wp_get_current_user()
  64  * @global WP_User $current_user Checks if the current user is set.
  65  *
  66  * @return WP_User Current WP_User instance.
  67  */
  68 function wp_get_current_user() {
  69         return _wp_get_current_user();
  70 }
  71 endif;
  72
  73 if ( !function_exists('get_userdata') ) :
  74 /**
  75  * Retrieve user info by user ID.
  76  *
  77  * @since 0.71
  78  *
  79  * @param int $user_id User ID
  80  * @return WP_User|false WP_User object on success, false on failure.
  81  */
  82 function get_userdata( $user_id ) {
  83         return get_user_by( 'id', $user_id );
  84 }
  85 endif;
  86
  87 if ( !function_exists('get_user_by') ) :
  88 /**
  89  * Retrieve user info by a given field
  90  *
  91  * @since 2.8.0
  92  * @since 4.4.0 Added 'ID' as an alias of 'id' for the `$field` parameter.
  93  *
  94  * @param string     $field The field to retrieve the user with. id | ID | slug | email | login.
  95  * @param int|string $value A value for $field. A user ID, slug, email address, or login name.
  96  * @return WP_User|false WP_User object on success, false on failure.
  97  */
  98 function get_user_by( $field, $value ) {
  99         $userdata = WP_User::get_data_by( $field, $value );
 100
 101         if ( !$userdata )
 102                 return false;
 103
 104         $user = new WP_User;
 105         $user->init( $userdata );
 106
 107         return $user;
 108 }
 109 endif;
 110
 111 if ( !function_exists('cache_users') ) :
 112 /**
 113  * Retrieve info for user lists to prevent multiple queries by get_userdata()
 114  *
 115  * @since 3.0.0
 116  *
 117  * @global wpdb $wpdb WordPress database abstraction object.
 118  *
 119  * @param array $user_ids User ID numbers list
 120  */
 121 function cache_users( $user_ids ) {
 122         global $wpdb;
 123
 124         $clean = _get_non_cached_ids( $user_ids, 'users' );
 125
 126         if ( empty( $clean ) )
 127                 return;
 128
 129         $list = implode( ',', $clean );
 130
 131         $users = $wpdb->get_results( "SELECT * FROM $wpdb->users WHERE ID IN ($list)" );
 132
 133         $ids = array();
 134         foreach ( $users as $user ) {
 135                 update_user_caches( $user );
 136                 $ids[] = $user->ID;
 137         }
 138         update_meta_cache( 'user', $ids );
 139 }
 140 endif;
 141
 142 if ( !function_exists( 'wp_mail' ) ) :
 143 /**
 144  * Send mail, similar to PHP's mail
 145  *
 146  * A true return value does not automatically mean that the user received the
 147  * email successfully. It just only means that the method used was able to
 148  * process the request without any errors.
 149  *
 150  * Using the two 'wp_mail_from' and 'wp_mail_from_name' hooks allow from
 151  * creating a from address like 'Name <email@address.com>' when both are set. If
 152  * just 'wp_mail_from' is set, then just the email address will be used with no
 153  * name.
 154  *
 155  * The default content type is 'text/plain' which does not allow using HTML.
 156  * However, you can set the content type of the email by using the
 157  * {@see 'wp_mail_content_type'} filter.
 158  *
 159  * The default charset is based on the charset used on the blog. The charset can
 160  * be set using the {@see 'wp_mail_charset'} filter.
 161  *
 162  * @since 1.2.1
 163  *
 164  * @global PHPMailer $phpmailer
 165  *
 166  * @param string|array $to          Array or comma-separated list of email addresses to send message.
 167  * @param string       $subject     Email subject
 168  * @param string       $message     Message contents
 169  * @param string|array $headers     Optional. Additional headers.
 170  * @param string|array $attachments Optional. Files to attach.
 171  * @return bool Whether the email contents were sent successfully.
 172  */
 173 function wp_mail( $to, $subject, $message, $headers = '', $attachments = array() ) {
 174         // Compact the input, apply the filters, and extract them back out
 175
 176         /**
 177          * Filters the wp_mail() arguments.
 178          *
 179          * @since 2.2.0
 180          *
 181          * @param array $args A compacted array of wp_mail() arguments, including the "to" email,
 182          *                    subject, message, headers, and attachments values.
 183          */
 184         $atts = apply_filters( 'wp_mail', compact( 'to', 'subject', 'message', 'headers', 'attachments' ) );
 185
 186         if ( isset( $atts['to'] ) ) {
 187                 $to = $atts['to'];
 188         }
 189
 190         if ( isset( $atts['subject'] ) ) {
 191                 $subject = $atts['subject'];
 192         }
 193
 194         if ( isset( $atts['message'] ) ) {
 195                 $message = $atts['message'];
 196         }
 197
 198         if ( isset( $atts['headers'] ) ) {
 199                 $headers = $atts['headers'];
 200         }
 201
 202         if ( isset( $atts['attachments'] ) ) {
 203                 $attachments = $atts['attachments'];
 204         }
 205
 206         if ( ! is_array( $attachments ) ) {
 207                 $attachments = explode( "\n", str_replace( "\r\n", "\n", $attachments ) );
 208         }
 209         global $phpmailer;
 210
 211         // (Re)create it, if it's gone missing
 212         if ( ! ( $phpmailer instanceof PHPMailer ) ) {
 213                 require_once ABSPATH . WPINC . '/class-phpmailer.php';
 214                 require_once ABSPATH . WPINC . '/class-smtp.php';
 215                 $phpmailer = new PHPMailer( true );
 216         }
 217
 218         // Headers
 219         $cc = $bcc = $reply_to = array();
 220
 221         if ( empty( $headers ) ) {
 222                 $headers = array();
 223         } else {
 224                 if ( !is_array( $headers ) ) {
 225                         // Explode the headers out, so this function can take both
 226                         // string headers and an array of headers.
 227                         $tempheaders = explode( "\n", str_replace( "\r\n", "\n", $headers ) );
 228                 } else {
 229                         $tempheaders = $headers;
 230                 }
 231                 $headers = array();
 232
 233                 // If it's actually got contents
 234                 if ( !empty( $tempheaders ) ) {
 235                         // Iterate through the raw headers
 236                         foreach ( (array) $tempheaders as $header ) {
 237                                 if ( strpos($header, ':') === false ) {
 238                                         if ( false !== stripos( $header, 'boundary=' ) ) {
 239                                                 $parts = preg_split('/boundary=/i', trim( $header ) );
 240                                                 $boundary = trim( str_replace( array( "'", '"' ), '', $parts[1] ) );
 241                                         }
 242                                         continue;
 243                                 }
 244                                 // Explode them out
 245                                 list( $name, $content ) = explode( ':', trim( $header ), 2 );
 246
 247                                 // Cleanup crew
 248                                 $name    = trim( $name    );
 249                                 $content = trim( $content );
 250
 251                                 switch ( strtolower( $name ) ) {
 252                                         // Mainly for legacy -- process a From: header if it's there
 253                                         case 'from':
 254                                                 $bracket_pos = strpos( $content, '<' );
 255                                                 if ( $bracket_pos !== false ) {
 256                                                         // Text before the bracketed email is the "From" name.
 257                                                         if ( $bracket_pos > 0 ) {
 258                                                                 $from_name = substr( $content, 0, $bracket_pos - 1 );
 259                                                                 $from_name = str_replace( '"', '', $from_name );
 260                                                                 $from_name = trim( $from_name );
 261                                                         }
 262
 263                                                         $from_email = substr( $content, $bracket_pos + 1 );
 264                                                         $from_email = str_replace( '>', '', $from_email );
 265                                                         $from_email = trim( $from_email );
 266
 267                                                 // Avoid setting an empty $from_email.
 268                                                 } elseif ( '' !== trim( $content ) ) {
 269                                                         $from_email = trim( $content );
 270                                                 }
 271                                                 break;
 272                                         case 'content-type':
 273                                                 if ( strpos( $content, ';' ) !== false ) {
 274                                                         list( $type, $charset_content ) = explode( ';', $content );
 275                                                         $content_type = trim( $type );
 276                                                         if ( false !== stripos( $charset_content, 'charset=' ) ) {
 277                                                                 $charset = trim( str_replace( array( 'charset=', '"' ), '', $charset_content ) );
 278                                                         } elseif ( false !== stripos( $charset_content, 'boundary=' ) ) {
 279                                                                 $boundary = trim( str_replace( array( 'BOUNDARY=', 'boundary=', '"' ), '', $charset_content ) );
 280                                                                 $charset = '';
 281                                                         }
 282
 283                                                 // Avoid setting an empty $content_type.
 284                                                 } elseif ( '' !== trim( $content ) ) {
 285                                                         $content_type = trim( $content );
 286                                                 }
 287                                                 break;
 288                                         case 'cc':
 289                                                 $cc = array_merge( (array) $cc, explode( ',', $content ) );
 290                                                 break;
 291                                         case 'bcc':
 292                                                 $bcc = array_merge( (array) $bcc, explode( ',', $content ) );
 293                                                 break;
 294                                         case 'reply-to':
 295                                                 $reply_to = array_merge( (array) $reply_to, explode( ',', $content ) );
 296                                                 break;
 297                                         default:
 298                                                 // Add it to our grand headers array
 299                                                 $headers[trim( $name )] = trim( $content );
 300                                                 break;
 301                                 }
 302                         }
 303                 }
 304         }
 305
 306         // Empty out the values that may be set
 307         $phpmailer->ClearAllRecipients();
 308         $phpmailer->ClearAttachments();
 309         $phpmailer->ClearCustomHeaders();
 310         $phpmailer->ClearReplyTos();
 311
 312         // From email and name
 313         // If we don't have a name from the input headers
 314         if ( !isset( $from_name ) )
 315                 $from_name = 'WordPress';
 316
 317         /* If we don't have an email from the input headers default to wordpress@$sitename
 318          * Some hosts will block outgoing mail from this address if it doesn't exist but
 319          * there's no easy alternative. Defaulting to admin_email might appear to be another
 320          * option but some hosts may refuse to relay mail from an unknown domain. See
 321          * https://core.trac.wordpress.org/ticket/5007.
 322          */
 323
 324         if ( !isset( $from_email ) ) {
 325                 // Get the site domain and get rid of www.
 326                 $sitename = strtolower( $_SERVER['SERVER_NAME'] );
 327                 if ( substr( $sitename, 0, 4 ) == 'www.' ) {
 328                         $sitename = substr( $sitename, 4 );
 329                 }
 330
 331                 $from_email = 'wordpress@' . $sitename;
 332         }
 333
 334         /**
 335          * Filters the email address to send from.
 336          *
 337          * @since 2.2.0
 338          *
 339          * @param string $from_email Email address to send from.
 340          */
 341         $from_email = apply_filters( 'wp_mail_from', $from_email );
 342
 343         /**
 344          * Filters the name to associate with the "from" email address.
 345          *
 346          * @since 2.3.0
 347          *
 348          * @param string $from_name Name associated with the "from" email address.
 349          */
 350         $from_name = apply_filters( 'wp_mail_from_name', $from_name );
 351
 352         $phpmailer->setFrom( $from_email, $from_name, false );
 353
 354         // Set destination addresses
 355         if ( !is_array( $to ) )
 356                 $to = explode( ',', $to );
 357
 358         // Set mail's subject and body
 359         $phpmailer->Subject = $subject;
 360         $phpmailer->Body    = $message;
 361
 362         // Use appropriate methods for handling addresses, rather than treating them as generic headers
 363         $address_headers = compact( 'to', 'cc', 'bcc', 'reply_to' );
 364
 365         foreach ( $address_headers as $address_header => $addresses ) {
 366                 if ( empty( $addresses ) ) {
 367                         continue;
 368                 }
 369
 370                 foreach ( (array) $addresses as $address ) {
 371                         try {
 372                                 // Break $recipient into name and address parts if in the format "Foo <bar@baz.com>"
 373                                 $recipient_name = '';
 374
 375                                 if ( preg_match( '/(.*)<(.+)>/', $address, $matches ) ) {
 376                                         if ( count( $matches ) == 3 ) {
 377                                                 $recipient_name = $matches[1];
 378                                                 $address        = $matches[2];
 379                                         }
 380                                 }
 381
 382                                 switch ( $address_header ) {
 383                                         case 'to':
 384                                                 $phpmailer->addAddress( $address, $recipient_name );
 385                                                 break;
 386                                         case 'cc':
 387                                                 $phpmailer->addCc( $address, $recipient_name );
 388                                                 break;
 389                                         case 'bcc':
 390                                                 $phpmailer->addBcc( $address, $recipient_name );
 391                                                 break;
 392                                         case 'reply_to':
 393                                                 $phpmailer->addReplyTo( $address, $recipient_name );
 394                                                 break;
 395                                 }
 396                         } catch ( phpmailerException $e ) {
 397                                 continue;
 398                         }
 399                 }
 400         }
 401
 402         // Set to use PHP's mail()
 403         $phpmailer->IsMail();
 404
 405         // Set Content-Type and charset
 406         // If we don't have a content-type from the input headers
 407         if ( !isset( $content_type ) )
 408                 $content_type = 'text/plain';
 409
 410         /**
 411          * Filters the wp_mail() content type.
 412          *
 413          * @since 2.3.0
 414          *
 415          * @param string $content_type Default wp_mail() content type.
 416          */
 417         $content_type = apply_filters( 'wp_mail_content_type', $content_type );
 418
 419         $phpmailer->ContentType = $content_type;
 420
 421         // Set whether it's plaintext, depending on $content_type
 422         if ( 'text/html' == $content_type )
 423                 $phpmailer->IsHTML( true );
 424
 425         // If we don't have a charset from the input headers
 426         if ( !isset( $charset ) )
 427                 $charset = get_bloginfo( 'charset' );
 428
 429         // Set the content-type and charset
 430
 431         /**
 432          * Filters the default wp_mail() charset.
 433          *
 434          * @since 2.3.0
 435          *
 436          * @param string $charset Default email charset.
 437          */
 438         $phpmailer->CharSet = apply_filters( 'wp_mail_charset', $charset );
 439
 440         // Set custom headers
 441         if ( !empty( $headers ) ) {
 442                 foreach ( (array) $headers as $name => $content ) {
 443                         $phpmailer->AddCustomHeader( sprintf( '%1$s: %2$s', $name, $content ) );
 444                 }
 445
 446                 if ( false !== stripos( $content_type, 'multipart' ) && ! empty($boundary) )
 447                         $phpmailer->AddCustomHeader( sprintf( "Content-Type: %s;\n\t boundary=\"%s\"", $content_type, $boundary ) );
 448         }
 449
 450         if ( !empty( $attachments ) ) {
 451                 foreach ( $attachments as $attachment ) {
 452                         try {
 453                                 $phpmailer->AddAttachment($attachment);
 454                         } catch ( phpmailerException $e ) {
 455                                 continue;
 456                         }
 457                 }
 458         }
 459
 460         /**
 461          * Fires after PHPMailer is initialized.
 462          *
 463          * @since 2.2.0
 464          *
 465          * @param PHPMailer &$phpmailer The PHPMailer instance, passed by reference.
 466          */
 467         do_action_ref_array( 'phpmailer_init', array( &$phpmailer ) );
 468
 469         // Send!
 470         try {
 471                 return $phpmailer->Send();
 472         } catch ( phpmailerException $e ) {
 473
 474                 $mail_error_data = compact( 'to', 'subject', 'message', 'headers', 'attachments' );
 475                 $mail_error_data['phpmailer_exception_code'] = $e->getCode();
 476
 477                 /**
 478                  * Fires after a phpmailerException is caught.
 479                  *
 480                  * @since 4.4.0
 481                  *
 482                  * @param WP_Error $error A WP_Error object with the phpmailerException message, and an array
 483                  *                        containing the mail recipient, subject, message, headers, and attachments.
 484                  */
 485                 do_action( 'wp_mail_failed', new WP_Error( 'wp_mail_failed', $e->getMessage(), $mail_error_data ) );
 486
 487                 return false;
 488         }
 489 }
 490 endif;
 491
 492 if ( !function_exists('wp_authenticate') ) :
 493 /**
 494  * Authenticate a user, confirming the login credentials are valid.
 495  *
 496  * @since 2.5.0
 497  * @since 4.5.0 `$username` now accepts an email address.
 498  *
 499  * @param string $username User's username or email address.
 500  * @param string $password User's password.
 501  * @return WP_User|WP_Error WP_User object if the credentials are valid,
 502  *                          otherwise WP_Error.
 503  */
 504 function wp_authenticate($username, $password) {
 505         $username = sanitize_user($username);
 506         $password = trim($password);
 507
 508         /**
 509          * Filters whether a set of user login credentials are valid.
 510          *
 511          * A WP_User object is returned if the credentials authenticate a user.
 512          * WP_Error or null otherwise.
 513          *
 514          * @since 2.8.0
 515          * @since 4.5.0 `$username` now accepts an email address.
 516          *
 517          * @param null|WP_User|WP_Error $user     WP_User if the user is authenticated.
 518          *                                        WP_Error or null otherwise.
 519          * @param string                $username Username or email address.
 520          * @param string                $password User password
 521          */
 522         $user = apply_filters( 'authenticate', null, $username, $password );
 523
 524         if ( $user == null ) {
 525                 // TODO what should the error message be? (Or would these even happen?)
 526                 // Only needed if all authentication handlers fail to return anything.
 527                 $user = new WP_Error( 'authentication_failed', __( '<strong>ERROR</strong>: Invalid username, email address or incorrect password.' ) );
 528         }
 529
 530         $ignore_codes = array('empty_username', 'empty_password');
 531
 532         if (is_wp_error($user) && !in_array($user->get_error_code(), $ignore_codes) ) {
 533                 /**
 534                  * Fires after a user login has failed.
 535                  *
 536                  * @since 2.5.0
 537                  * @since 4.5.0 The value of `$username` can now be an email address.
 538                  *
 539                  * @param string $username Username or email address.
 540                  */
 541                 do_action( 'wp_login_failed', $username );
 542         }
 543
 544         return $user;
 545 }
 546 endif;
 547
 548 if ( !function_exists('wp_logout') ) :
 549 /**
 550  * Log the current user out.
 551  *
 552  * @since 2.5.0
 553  */
 554 function wp_logout() {
 555         wp_destroy_current_session();
 556         wp_clear_auth_cookie();
 557
 558         /**
 559          * Fires after a user is logged-out.
 560          *
 561          * @since 1.5.0
 562          */
 563         do_action( 'wp_logout' );
 564 }
 565 endif;
 566
 567 if ( !function_exists('wp_validate_auth_cookie') ) :
 568 /**
 569  * Validates authentication cookie.
 570  *
 571  * The checks include making sure that the authentication cookie is set and
 572  * pulling in the contents (if $cookie is not used).
 573  *
 574  * Makes sure the cookie is not expired. Verifies the hash in cookie is what is
 575  * should be and compares the two.
 576  *
 577  * @since 2.5.0
 578  *
 579  * @global int $login_grace_period
 580  *
 581  * @param string $cookie Optional. If used, will validate contents instead of cookie's
 582  * @param string $scheme Optional. The cookie scheme to use: auth, secure_auth, or logged_in
 583  * @return false|int False if invalid cookie, User ID if valid.
 584  */
 585 function wp_validate_auth_cookie($cookie = '', $scheme = '') {
 586         if ( ! $cookie_elements = wp_parse_auth_cookie($cookie, $scheme) ) {
 587                 /**
 588                  * Fires if an authentication cookie is malformed.
 589                  *
 590                  * @since 2.7.0
 591                  *
 592                  * @param string $cookie Malformed auth cookie.
 593                  * @param string $scheme Authentication scheme. Values include 'auth', 'secure_auth',
 594                  *                       or 'logged_in'.
 595                  */
 596                 do_action( 'auth_cookie_malformed', $cookie, $scheme );
 597                 return false;
 598         }
 599
 600         $scheme = $cookie_elements['scheme'];
 601         $username = $cookie_elements['username'];
 602         $hmac = $cookie_elements['hmac'];
 603         $token = $cookie_elements['token'];
 604         $expired = $expiration = $cookie_elements['expiration'];
 605
 606         // Allow a grace period for POST and Ajax requests
 607         if ( wp_doing_ajax() || 'POST' == $_SERVER['REQUEST_METHOD'] ) {
 608                 $expired += HOUR_IN_SECONDS;
 609         }
 610
 611         // Quick check to see if an honest cookie has expired
 612         if ( $expired < time() ) {
 613                 /**
 614                  * Fires once an authentication cookie has expired.
 615                  *
 616                  * @since 2.7.0
 617                  *
 618                  * @param array $cookie_elements An array of data for the authentication cookie.
 619                  */
 620                 do_action( 'auth_cookie_expired', $cookie_elements );
 621                 return false;
 622         }
 623
 624         $user = get_user_by('login', $username);
 625         if ( ! $user ) {
 626                 /**
 627                  * Fires if a bad username is entered in the user authentication process.
 628                  *
 629                  * @since 2.7.0
 630                  *
 631                  * @param array $cookie_elements An array of data for the authentication cookie.
 632                  */
 633                 do_action( 'auth_cookie_bad_username', $cookie_elements );
 634                 return false;
 635         }
 636
 637         $pass_frag = substr($user->user_pass, 8, 4);
 638
 639         $key = wp_hash( $username . '|' . $pass_frag . '|' . $expiration . '|' . $token, $scheme );
 640
 641         // If ext/hash is not present, compat.php's hash_hmac() does not support sha256.
 642         $algo = function_exists( 'hash' ) ? 'sha256' : 'sha1';
 643         $hash = hash_hmac( $algo, $username . '|' . $expiration . '|' . $token, $key );
 644
 645         if ( ! hash_equals( $hash, $hmac ) ) {
 646                 /**
 647                  * Fires if a bad authentication cookie hash is encountered.
 648                  *
 649                  * @since 2.7.0
 650                  *
 651                  * @param array $cookie_elements An array of data for the authentication cookie.
 652                  */
 653                 do_action( 'auth_cookie_bad_hash', $cookie_elements );
 654                 return false;
 655         }
 656
 657         $manager = WP_Session_Tokens::get_instance( $user->ID );
 658         if ( ! $manager->verify( $token ) ) {
 659                 do_action( 'auth_cookie_bad_session_token', $cookie_elements );
 660                 return false;
 661         }
 662
 663         // Ajax/POST grace period set above
 664         if ( $expiration < time() ) {
 665                 $GLOBALS['login_grace_period'] = 1;
 666         }
 667
 668         /**
 669          * Fires once an authentication cookie has been validated.
 670          *
 671          * @since 2.7.0
 672          *
 673          * @param array   $cookie_elements An array of data for the authentication cookie.
 674          * @param WP_User $user            User object.
 675          */
 676         do_action( 'auth_cookie_valid', $cookie_elements, $user );
 677
 678         return $user->ID;
 679 }
 680 endif;
 681
 682 if ( !function_exists('wp_generate_auth_cookie') ) :
 683 /**
 684  * Generate authentication cookie contents.
 685  *
 686  * @since 2.5.0
 687  *
 688  * @param int    $user_id    User ID
 689  * @param int    $expiration The time the cookie expires as a UNIX timestamp.
 690  * @param string $scheme     Optional. The cookie scheme to use: auth, secure_auth, or logged_in
 691  * @param string $token      User's session token to use for this cookie
 692  * @return string Authentication cookie contents. Empty string if user does not exist.
 693  */
 694 function wp_generate_auth_cookie( $user_id, $expiration, $scheme = 'auth', $token = '' ) {
 695         $user = get_userdata($user_id);
 696         if ( ! $user ) {
 697                 return '';
 698         }
 699
 700         if ( ! $token ) {
 701                 $manager = WP_Session_Tokens::get_instance( $user_id );
 702                 $token = $manager->create( $expiration );
 703         }
 704
 705         $pass_frag = substr($user->user_pass, 8, 4);
 706
 707         $key = wp_hash( $user->user_login . '|' . $pass_frag . '|' . $expiration . '|' . $token, $scheme );
 708
 709         // If ext/hash is not present, compat.php's hash_hmac() does not support sha256.
 710         $algo = function_exists( 'hash' ) ? 'sha256' : 'sha1';
 711         $hash = hash_hmac( $algo, $user->user_login . '|' . $expiration . '|' . $token, $key );
 712
 713         $cookie = $user->user_login . '|' . $expiration . '|' . $token . '|' . $hash;
 714
 715         /**
 716          * Filters the authentication cookie.
 717          *
 718          * @since 2.5.0
 719          *
 720          * @param string $cookie     Authentication cookie.
 721          * @param int    $user_id    User ID.
 722          * @param int    $expiration The time the cookie expires as a UNIX timestamp.
 723          * @param string $scheme     Cookie scheme used. Accepts 'auth', 'secure_auth', or 'logged_in'.
 724          * @param string $token      User's session token used.
 725          */
 726         return apply_filters( 'auth_cookie', $cookie, $user_id, $expiration, $scheme, $token );
 727 }
 728 endif;
 729
 730 if ( !function_exists('wp_parse_auth_cookie') ) :
 731 /**
 732  * Parse a cookie into its components
 733  *
 734  * @since 2.7.0
 735  *
 736  * @param string $cookie
 737  * @param string $scheme Optional. The cookie scheme to use: auth, secure_auth, or logged_in
 738  * @return array|false Authentication cookie components
 739  */
 740 function wp_parse_auth_cookie($cookie = '', $scheme = '') {
 741         if ( empty($cookie) ) {
 742                 switch ($scheme){
 743                         case 'auth':
 744                                 $cookie_name = AUTH_COOKIE;
 745                                 break;
 746                         case 'secure_auth':
 747                                 $cookie_name = SECURE_AUTH_COOKIE;
 748                                 break;
 749                         case "logged_in":
 750                                 $cookie_name = LOGGED_IN_COOKIE;
 751                                 break;
 752                         default:
 753                                 if ( is_ssl() ) {
 754                                         $cookie_name = SECURE_AUTH_COOKIE;
 755                                         $scheme = 'secure_auth';
 756                                 } else {
 757                                         $cookie_name = AUTH_COOKIE;
 758                                         $scheme = 'auth';
 759                                 }
 760             }
 761
 762                 if ( empty($_COOKIE[$cookie_name]) )
 763                         return false;
 764                 $cookie = $_COOKIE[$cookie_name];
 765         }
 766
 767         $cookie_elements = explode('|', $cookie);
 768         if ( count( $cookie_elements ) !== 4 ) {
 769                 return false;
 770         }
 771
 772         list( $username, $expiration, $token, $hmac ) = $cookie_elements;
 773
 774         return compact( 'username', 'expiration', 'token', 'hmac', 'scheme' );
 775 }
 776 endif;
 777
 778 if ( !function_exists('wp_set_auth_cookie') ) :
 779 /**
 780  * Log in a user by setting authentication cookies.
 781  *
 782  * The $remember parameter increases the time that the cookie will be kept. The
 783  * default the cookie is kept without remembering is two days. When $remember is
 784  * set, the cookies will be kept for 14 days or two weeks.
 785  *
 786  * @since 2.5.0
 787  * @since 4.3.0 Added the `$token` parameter.
 788  *
 789  * @param int    $user_id  User ID
 790  * @param bool   $remember Whether to remember the user
 791  * @param mixed  $secure   Whether the admin cookies should only be sent over HTTPS.
 792  *                         Default is_ssl().
 793  * @param string $token    Optional. User's session token to use for this cookie.
 794  */
 795 function wp_set_auth_cookie( $user_id, $remember = false, $secure = '', $token = '' ) {
 796         if ( $remember ) {
 797                 /**
 798                  * Filters the duration of the authentication cookie expiration period.
 799                  *
 800                  * @since 2.8.0
 801                  *
 802                  * @param int  $length   Duration of the expiration period in seconds.
 803                  * @param int  $user_id  User ID.
 804                  * @param bool $remember Whether to remember the user login. Default false.
 805                  */
 806                 $expiration = time() + apply_filters( 'auth_cookie_expiration', 14 * DAY_IN_SECONDS, $user_id, $remember );
 807
 808                 /*
 809                  * Ensure the browser will continue to send the cookie after the expiration time is reached.
 810                  * Needed for the login grace period in wp_validate_auth_cookie().
 811                  */
 812                 $expire = $expiration + ( 12 * HOUR_IN_SECONDS );
 813         } else {
 814                 /** This filter is documented in wp-includes/pluggable.php */
 815                 $expiration = time() + apply_filters( 'auth_cookie_expiration', 2 * DAY_IN_SECONDS, $user_id, $remember );
 816                 $expire = 0;
 817         }
 818
 819         if ( '' === $secure ) {
 820                 $secure = is_ssl();
 821         }
 822
 823         // Front-end cookie is secure when the auth cookie is secure and the site's home URL is forced HTTPS.
 824         $secure_logged_in_cookie = $secure && 'https' === parse_url( get_option( 'home' ), PHP_URL_SCHEME );
 825
 826         /**
 827          * Filters whether the connection is secure.
 828          *
 829          * @since 3.1.0
 830          *
 831          * @param bool $secure  Whether the connection is secure.
 832          * @param int  $user_id User ID.
 833          */
 834         $secure = apply_filters( 'secure_auth_cookie', $secure, $user_id );
 835
 836         /**
 837          * Filters whether to use a secure cookie when logged-in.
 838          *
 839          * @since 3.1.0
 840          *
 841          * @param bool $secure_logged_in_cookie Whether to use a secure cookie when logged-in.
 842          * @param int  $user_id                 User ID.
 843          * @param bool $secure                  Whether the connection is secure.
 844          */
 845         $secure_logged_in_cookie = apply_filters( 'secure_logged_in_cookie', $secure_logged_in_cookie, $user_id, $secure );
 846
 847         if ( $secure ) {
 848                 $auth_cookie_name = SECURE_AUTH_COOKIE;
 849                 $scheme = 'secure_auth';
 850         } else {
 851                 $auth_cookie_name = AUTH_COOKIE;
 852                 $scheme = 'auth';
 853         }
 854
 855         if ( '' === $token ) {
 856                 $manager = WP_Session_Tokens::get_instance( $user_id );
 857                 $token   = $manager->create( $expiration );
 858         }
 859
 860         $auth_cookie = wp_generate_auth_cookie( $user_id, $expiration, $scheme, $token );
 861         $logged_in_cookie = wp_generate_auth_cookie( $user_id, $expiration, 'logged_in', $token );
 862
 863         /**
 864          * Fires immediately before the authentication cookie is set.
 865          *
 866          * @since 2.5.0
 867          *
 868          * @param string $auth_cookie Authentication cookie.
 869          * @param int    $expire      The time the login grace period expires as a UNIX timestamp.
 870          *                            Default is 12 hours past the cookie's expiration time.
 871          * @param int    $expiration  The time when the authentication cookie expires as a UNIX timestamp.
 872          *                            Default is 14 days from now.
 873          * @param int    $user_id     User ID.
 874          * @param string $scheme      Authentication scheme. Values include 'auth', 'secure_auth', or 'logged_in'.
 875          */
 876         do_action( 'set_auth_cookie', $auth_cookie, $expire, $expiration, $user_id, $scheme );
 877
 878         /**
 879          * Fires immediately before the logged-in authentication cookie is set.
 880          *
 881          * @since 2.6.0
 882          *
 883          * @param string $logged_in_cookie The logged-in cookie.
 884          * @param int    $expire           The time the login grace period expires as a UNIX timestamp.
 885          *                                 Default is 12 hours past the cookie's expiration time.
 886          * @param int    $expiration       The time when the logged-in authentication cookie expires as a UNIX timestamp.
 887          *                                 Default is 14 days from now.
 888          * @param int    $user_id          User ID.
 889          * @param string $scheme           Authentication scheme. Default 'logged_in'.
 890          */
 891         do_action( 'set_logged_in_cookie', $logged_in_cookie, $expire, $expiration, $user_id, 'logged_in' );
 892
 893         setcookie($auth_cookie_name, $auth_cookie, $expire, PLUGINS_COOKIE_PATH, COOKIE_DOMAIN, $secure, true);
 894         setcookie($auth_cookie_name, $auth_cookie, $expire, ADMIN_COOKIE_PATH, COOKIE_DOMAIN, $secure, true);
 895         setcookie(LOGGED_IN_COOKIE, $logged_in_cookie, $expire, COOKIEPATH, COOKIE_DOMAIN, $secure_logged_in_cookie, true);
 896         if ( COOKIEPATH != SITECOOKIEPATH )
 897                 setcookie(LOGGED_IN_COOKIE, $logged_in_cookie, $expire, SITECOOKIEPATH, COOKIE_DOMAIN, $secure_logged_in_cookie, true);
 898 }
 899 endif;
 900
 901 if ( !function_exists('wp_clear_auth_cookie') ) :
 902 /**
 903  * Removes all of the cookies associated with authentication.
 904  *
 905  * @since 2.5.0
 906  */
 907 function wp_clear_auth_cookie() {
 908         /**
 909          * Fires just before the authentication cookies are cleared.
 910          *
 911          * @since 2.7.0
 912          */
 913         do_action( 'clear_auth_cookie' );
 914
 915         setcookie( AUTH_COOKIE,        ' ', time() - YEAR_IN_SECONDS, ADMIN_COOKIE_PATH,   COOKIE_DOMAIN );
 916         setcookie( SECURE_AUTH_COOKIE, ' ', time() - YEAR_IN_SECONDS, ADMIN_COOKIE_PATH,   COOKIE_DOMAIN );
 917         setcookie( AUTH_COOKIE,        ' ', time() - YEAR_IN_SECONDS, PLUGINS_COOKIE_PATH, COOKIE_DOMAIN );
 918         setcookie( SECURE_AUTH_COOKIE, ' ', time() - YEAR_IN_SECONDS, PLUGINS_COOKIE_PATH, COOKIE_DOMAIN );
 919         setcookie( LOGGED_IN_COOKIE,   ' ', time() - YEAR_IN_SECONDS, COOKIEPATH,          COOKIE_DOMAIN );
 920         setcookie( LOGGED_IN_COOKIE,   ' ', time() - YEAR_IN_SECONDS, SITECOOKIEPATH,      COOKIE_DOMAIN );
 921
 922         // Old cookies
 923         setcookie( AUTH_COOKIE,        ' ', time() - YEAR_IN_SECONDS, COOKIEPATH,     COOKIE_DOMAIN );
 924         setcookie( AUTH_COOKIE,        ' ', time() - YEAR_IN_SECONDS, SITECOOKIEPATH, COOKIE_DOMAIN );
 925         setcookie( SECURE_AUTH_COOKIE, ' ', time() - YEAR_IN_SECONDS, COOKIEPATH,     COOKIE_DOMAIN );
 926         setcookie( SECURE_AUTH_COOKIE, ' ', time() - YEAR_IN_SECONDS, SITECOOKIEPATH, COOKIE_DOMAIN );
 927
 928         // Even older cookies
 929         setcookie( USER_COOKIE, ' ', time() - YEAR_IN_SECONDS, COOKIEPATH,     COOKIE_DOMAIN );
 930         setcookie( PASS_COOKIE, ' ', time() - YEAR_IN_SECONDS, COOKIEPATH,     COOKIE_DOMAIN );
 931         setcookie( USER_COOKIE, ' ', time() - YEAR_IN_SECONDS, SITECOOKIEPATH, COOKIE_DOMAIN );
 932         setcookie( PASS_COOKIE, ' ', time() - YEAR_IN_SECONDS, SITECOOKIEPATH, COOKIE_DOMAIN );
 933 }
 934 endif;
 935
 936 if ( !function_exists('is_user_logged_in') ) :
 937 /**
 938  * Checks if the current visitor is a logged in user.
 939  *
 940  * @since 2.0.0
 941  *
 942  * @return bool True if user is logged in, false if not logged in.
 943  */
 944 function is_user_logged_in() {
 945         $user = wp_get_current_user();
 946
 947         return $user->exists();
 948 }
 949 endif;
 950
 951 if ( !function_exists('auth_redirect') ) :
 952 /**
 953  * Checks if a user is logged in, if not it redirects them to the login page.
 954  *
 955  * @since 1.5.0
 956  */
 957 function auth_redirect() {
 958         // Checks if a user is logged in, if not redirects them to the login page
 959
 960         $secure = ( is_ssl() || force_ssl_admin() );
 961
 962         /**
 963          * Filters whether to use a secure authentication redirect.
 964          *
 965          * @since 3.1.0
 966          *
 967          * @param bool $secure Whether to use a secure authentication redirect. Default false.
 968          */
 969         $secure = apply_filters( 'secure_auth_redirect', $secure );
 970
 971         // If https is required and request is http, redirect
 972         if ( $secure && !is_ssl() && false !== strpos($_SERVER['REQUEST_URI'], 'wp-admin') ) {
 973                 if ( 0 === strpos( $_SERVER['REQUEST_URI'], 'http' ) ) {
 974                         wp_redirect( set_url_scheme( $_SERVER['REQUEST_URI'], 'https' ) );
 975                         exit();
 976                 } else {
 977                         wp_redirect( 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );
 978                         exit();
 979                 }
 980         }
 981
 982         /**
 983          * Filters the authentication redirect scheme.
 984          *
 985          * @since 2.9.0
 986          *
 987          * @param string $scheme Authentication redirect scheme. Default empty.
 988          */
 989         $scheme = apply_filters( 'auth_redirect_scheme', '' );
 990
 991         if ( $user_id = wp_validate_auth_cookie( '',  $scheme) ) {
 992                 /**
 993                  * Fires before the authentication redirect.
 994                  *
 995                  * @since 2.8.0
 996                  *
 997                  * @param int $user_id User ID.
 998                  */
 999                 do_action( 'auth_redirect', $user_id );
1000
1001                 // If the user wants ssl but the session is not ssl, redirect.
1002                 if ( !$secure && get_user_option('use_ssl', $user_id) && false !== strpos($_SERVER['REQUEST_URI'], 'wp-admin') ) {
1003                         if ( 0 === strpos( $_SERVER['REQUEST_URI'], 'http' ) ) {
1004                                 wp_redirect( set_url_scheme( $_SERVER['REQUEST_URI'], 'https' ) );
1005                                 exit();
1006                         } else {
1007                                 wp_redirect( 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );
1008                                 exit();
1009                         }
1010                 }
1011
1012                 return;  // The cookie is good so we're done
1013         }
1014
1015         // The cookie is no good so force login
1016         nocache_headers();
1017
1018         $redirect = ( strpos( $_SERVER['REQUEST_URI'], '/options.php' ) && wp_get_referer() ) ? wp_get_referer() : set_url_scheme( 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );
1019
1020         $login_url = wp_login_url($redirect, true);
1021
1022         wp_redirect($login_url);
1023         exit();
1024 }
1025 endif;
1026
1027 if ( !function_exists('check_admin_referer') ) :
1028 /**
1029  * Makes sure that a user was referred from another admin page.
1030  *
1031  * To avoid security exploits.
1032  *
1033  * @since 1.2.0
1034  *
1035  * @param int|string $action    Action nonce.
1036  * @param string     $query_arg Optional. Key to check for nonce in `$_REQUEST` (since 2.5).
1037  *                              Default '_wpnonce'.
1038  * @return false|int False if the nonce is invalid, 1 if the nonce is valid and generated between
1039  *                   0-12 hours ago, 2 if the nonce is valid and generated between 12-24 hours ago.
1040  */
1041 function check_admin_referer( $action = -1, $query_arg = '_wpnonce' ) {
1042         if ( -1 == $action )
1043                 _doing_it_wrong( __FUNCTION__, __( 'You should specify a nonce action to be verified by using the first parameter.' ), '3.2.0' );
1044
1045         $adminurl = strtolower(admin_url());
1046         $referer = strtolower(wp_get_referer());
1047         $result = isset($_REQUEST[$query_arg]) ? wp_verify_nonce($_REQUEST[$query_arg], $action) : false;
1048
1049         /**
1050          * Fires once the admin request has been validated or not.
1051          *
1052          * @since 1.5.1
1053          *
1054          * @param string    $action The nonce action.
1055          * @param false|int $result False if the nonce is invalid, 1 if the nonce is valid and generated between
1056          *                          0-12 hours ago, 2 if the nonce is valid and generated between 12-24 hours ago.
1057          */
1058         do_action( 'check_admin_referer', $action, $result );
1059
1060         if ( ! $result && ! ( -1 == $action && strpos( $referer, $adminurl ) === 0 ) ) {
1061                 wp_nonce_ays( $action );
1062                 die();
1063         }
1064
1065         return $result;
1066 }
1067 endif;
1068
1069 if ( !function_exists('check_ajax_referer') ) :
1070 /**
1071  * Verifies the Ajax request to prevent processing requests external of the blog.
1072  *
1073  * @since 2.0.3
1074  *
1075  * @param int|string   $action    Action nonce.
1076  * @param false|string $query_arg Optional. Key to check for the nonce in `$_REQUEST` (since 2.5). If false,
1077  *                                `$_REQUEST` values will be evaluated for '_ajax_nonce', and '_wpnonce'
1078  *                                (in that order). Default false.
1079  * @param bool         $die       Optional. Whether to die early when the nonce cannot be verified.
1080  *                                Default true.
1081  * @return false|int False if the nonce is invalid, 1 if the nonce is valid and generated between
1082  *                   0-12 hours ago, 2 if the nonce is valid and generated between 12-24 hours ago.
1083  */
1084 function check_ajax_referer( $action = -1, $query_arg = false, $die = true ) {
1085         if ( -1 == $action ) {
1086                 _doing_it_wrong( __FUNCTION__, __( 'You should specify a nonce action to be verified by using the first parameter.' ), '4.7' );
1087         }
1088
1089         $nonce = '';
1090
1091         if ( $query_arg && isset( $_REQUEST[ $query_arg ] ) )
1092                 $nonce = $_REQUEST[ $query_arg ];
1093         elseif ( isset( $_REQUEST['_ajax_nonce'] ) )
1094                 $nonce = $_REQUEST['_ajax_nonce'];
1095         elseif ( isset( $_REQUEST['_wpnonce'] ) )
1096                 $nonce = $_REQUEST['_wpnonce'];
1097
1098         $result = wp_verify_nonce( $nonce, $action );
1099
1100         /**
1101          * Fires once the Ajax request has been validated or not.
1102          *
1103          * @since 2.1.0
1104          *
1105          * @param string    $action The Ajax nonce action.
1106          * @param false|int $result False if the nonce is invalid, 1 if the nonce is valid and generated between
1107          *                          0-12 hours ago, 2 if the nonce is valid and generated between 12-24 hours ago.
1108          */
1109         do_action( 'check_ajax_referer', $action, $result );
1110
1111         if ( $die && false === $result ) {
1112                 if ( wp_doing_ajax() ) {
1113                         wp_die( -1, 403 );
1114                 } else {
1115                         die( '-1' );
1116                 }
1117         }
1118
1119         return $result;
1120 }
1121 endif;
1122
1123 if ( !function_exists('wp_redirect') ) :
1124 /**
1125  * Redirects to another page.
1126  *
1127  * Note: wp_redirect() does not exit automatically, and should almost always be
1128  * followed by a call to `exit;`:
1129  *
1130  *     wp_redirect( $url );
1131  *     exit;
1132  *
1133  * Exiting can also be selectively manipulated by using wp_redirect() as a conditional
1134  * in conjunction with the {@see 'wp_redirect'} and {@see 'wp_redirect_location'} hooks:
1135  *
1136  *     if ( wp_redirect( $url ) ) {
1137  *         exit;
1138  *     }
1139  *
1140  * @since 1.5.1
1141  *
1142  * @global bool $is_IIS
1143  *
1144  * @param string $location The path to redirect to.
1145  * @param int    $status   Status code to use.
1146  * @return bool False if $location is not provided, true otherwise.
1147  */
1148 function wp_redirect($location, $status = 302) {
1149         global $is_IIS;
1150
1151         /**
1152          * Filters the redirect location.
1153          *
1154          * @since 2.1.0
1155          *
1156          * @param string $location The path to redirect to.
1157          * @param int    $status   Status code to use.
1158          */
1159         $location = apply_filters( 'wp_redirect', $location, $status );
1160
1161         /**
1162          * Filters the redirect status code.
1163          *
1164          * @since 2.3.0
1165          *
1166          * @param int    $status   Status code to use.
1167          * @param string $location The path to redirect to.
1168          */
1169         $status = apply_filters( 'wp_redirect_status', $status, $location );
1170
1171         if ( ! $location )
1172                 return false;
1173
1174         $location = wp_sanitize_redirect($location);
1175
1176         if ( !$is_IIS && PHP_SAPI != 'cgi-fcgi' )
1177                 status_header($status); // This causes problems on IIS and some FastCGI setups
1178
1179         header("Location: $location", true, $status);
1180
1181         return true;
1182 }
1183 endif;
1184
1185 if ( !function_exists('wp_sanitize_redirect') ) :
1186 /**
1187  * Sanitizes a URL for use in a redirect.
1188  *
1189  * @since 2.3.0
1190  *
1191  * @param string $location The path to redirect to.
1192  * @return string Redirect-sanitized URL.
1193  **/
1194 function wp_sanitize_redirect($location) {
1195         $regex = '/
1196                 (
1197                         (?: [\xC2-\xDF][\x80-\xBF]        # double-byte sequences   110xxxxx 10xxxxxx
1198                         |   \xE0[\xA0-\xBF][\x80-\xBF]    # triple-byte sequences   1110xxxx 10xxxxxx * 2
1199                         |   [\xE1-\xEC][\x80-\xBF]{2}
1200                         |   \xED[\x80-\x9F][\x80-\xBF]
1201                         |   [\xEE-\xEF][\x80-\xBF]{2}
1202                         |   \xF0[\x90-\xBF][\x80-\xBF]{2} # four-byte sequences   11110xxx 10xxxxxx * 3
1203                         |   [\xF1-\xF3][\x80-\xBF]{3}
1204                         |   \xF4[\x80-\x8F][\x80-\xBF]{2}
1205                 ){1,40}                              # ...one or more times
1206                 )/x';
1207         $location = preg_replace_callback( $regex, '_wp_sanitize_utf8_in_redirect', $location );
1208         $location = preg_replace('|[^a-z0-9-~+_.?#=&;,/:%!*\[\]()@]|i', '', $location);
1209         $location = wp_kses_no_null($location);
1210
1211         // remove %0d and %0a from location
1212         $strip = array('%0d', '%0a', '%0D', '%0A');
1213         return _deep_replace( $strip, $location );
1214 }
1215
1216 /**
1217  * URL encode UTF-8 characters in a URL.
1218  *
1219  * @ignore
1220  * @since 4.2.0
1221  * @access private
1222  *
1223  * @see wp_sanitize_redirect()
1224  *
1225  * @param array $matches RegEx matches against the redirect location.
1226  * @return string URL-encoded version of the first RegEx match.
1227  */
1228 function _wp_sanitize_utf8_in_redirect( $matches ) {
1229         return urlencode( $matches[0] );
1230 }
1231 endif;
1232
1233 if ( !function_exists('wp_safe_redirect') ) :
1234 /**
1235  * Performs a safe (local) redirect, using wp_redirect().
1236  *
1237  * Checks whether the $location is using an allowed host, if it has an absolute
1238  * path. A plugin can therefore set or remove allowed host(s) to or from the
1239  * list.
1240  *
1241  * If the host is not allowed, then the redirect defaults to wp-admin on the siteurl
1242  * instead. This prevents malicious redirects which redirect to another host,
1243  * but only used in a few places.
1244  *
1245  * @since 2.3.0
1246  *
1247  * @param string $location The path to redirect to.
1248  * @param int    $status   Status code to use.
1249  */
1250 function wp_safe_redirect($location, $status = 302) {
1251
1252         // Need to look at the URL the way it will end up in wp_redirect()
1253         $location = wp_sanitize_redirect($location);
1254
1255         /**
1256          * Filters the redirect fallback URL for when the provided redirect is not safe (local).
1257          *
1258          * @since 4.3.0
1259          *
1260          * @param string $fallback_url The fallback URL to use by default.
1261          * @param int    $status       The redirect status.
1262          */
1263         $location = wp_validate_redirect( $location, apply_filters( 'wp_safe_redirect_fallback', admin_url(), $status ) );
1264
1265         wp_redirect($location, $status);
1266 }
1267 endif;
1268
1269 if ( !function_exists('wp_validate_redirect') ) :
1270 /**
1271  * Validates a URL for use in a redirect.
1272  *
1273  * Checks whether the $location is using an allowed host, if it has an absolute
1274  * path. A plugin can therefore set or remove allowed host(s) to or from the
1275  * list.
1276  *
1277  * If the host is not allowed, then the redirect is to $default supplied
1278  *
1279  * @since 2.8.1
1280  *
1281  * @param string $location The redirect to validate
1282  * @param string $default  The value to return if $location is not allowed
1283  * @return string redirect-sanitized URL
1284  **/
1285 function wp_validate_redirect($location, $default = '') {
1286         $location = trim( $location );
1287         // browsers will assume 'http' is your protocol, and will obey a redirect to a URL starting with '//'
1288         if ( substr($location, 0, 2) == '//' )
1289                 $location = 'http:' . $location;
1290
1291         // In php 5 parse_url may fail if the URL query part contains http://, bug #38143
1292         $test = ( $cut = strpos($location, '?') ) ? substr( $location, 0, $cut ) : $location;
1293
1294         // @-operator is used to prevent possible warnings in PHP < 5.3.3.
1295         $lp = @parse_url($test);
1296
1297         // Give up if malformed URL
1298         if ( false === $lp )
1299                 return $default;
1300
1301         // Allow only http and https schemes. No data:, etc.
1302         if ( isset($lp['scheme']) && !('http' == $lp['scheme'] || 'https' == $lp['scheme']) )
1303                 return $default;
1304
1305         // Reject if certain components are set but host is not. This catches urls like https:host.com for which parse_url does not set the host field.
1306         if ( ! isset( $lp['host'] ) && ( isset( $lp['scheme'] ) || isset( $lp['user'] ) || isset( $lp['pass'] ) || isset( $lp['port'] ) ) ) {
1307                 return $default;
1308         }
1309
1310         // Reject malformed components parse_url() can return on odd inputs.
1311         foreach ( array( 'user', 'pass', 'host' ) as $component ) {
1312                 if ( isset( $lp[ $component ] ) && strpbrk( $lp[ $component ], ':/?#@' ) ) {
1313                         return $default;
1314                 }
1315         }
1316
1317         $wpp = parse_url(home_url());
1318
1319         /**
1320          * Filters the whitelist of hosts to redirect to.
1321          *
1322          * @since 2.3.0
1323          *
1324          * @param array       $hosts An array of allowed hosts.
1325          * @param bool|string $host  The parsed host; empty if not isset.
1326          */
1327         $allowed_hosts = (array) apply_filters( 'allowed_redirect_hosts', array($wpp['host']), isset($lp['host']) ? $lp['host'] : '' );
1328
1329         if ( isset($lp['host']) && ( !in_array($lp['host'], $allowed_hosts) && $lp['host'] != strtolower($wpp['host'])) )
1330                 $location = $default;
1331
1332         return $location;
1333 }
1334 endif;
1335
1336 if ( ! function_exists('wp_notify_postauthor') ) :
1337 /**
1338  * Notify an author (and/or others) of a comment/trackback/pingback on a post.
1339  *
1340  * @since 1.0.0
1341  *
1342  * @param int|WP_Comment  $comment_id Comment ID or WP_Comment object.
1343  * @param string          $deprecated Not used
1344  * @return bool True on completion. False if no email addresses were specified.
1345  */
1346 function wp_notify_postauthor( $comment_id, $deprecated = null ) {
1347         if ( null !== $deprecated ) {
1348                 _deprecated_argument( __FUNCTION__, '3.8.0' );
1349         }
1350
1351         $comment = get_comment( $comment_id );
1352         if ( empty( $comment ) || empty( $comment->comment_post_ID ) )
1353                 return false;
1354
1355         $post    = get_post( $comment->comment_post_ID );
1356         $author  = get_userdata( $post->post_author );
1357
1358         // Who to notify? By default, just the post author, but others can be added.
1359         $emails = array();
1360         if ( $author ) {
1361                 $emails[] = $author->user_email;
1362         }
1363
1364         /**
1365          * Filters the list of email addresses to receive a comment notification.
1366          *
1367          * By default, only post authors are notified of comments. This filter allows
1368          * others to be added.
1369          *
1370          * @since 3.7.0
1371          *
1372          * @param array $emails     An array of email addresses to receive a comment notification.
1373          * @param int   $comment_id The comment ID.
1374          */
1375         $emails = apply_filters( 'comment_notification_recipients', $emails, $comment->comment_ID );
1376         $emails = array_filter( $emails );
1377
1378         // If there are no addresses to send the comment to, bail.
1379         if ( ! count( $emails ) ) {
1380                 return false;
1381         }
1382
1383         // Facilitate unsetting below without knowing the keys.
1384         $emails = array_flip( $emails );
1385
1386         /**
1387          * Filters whether to notify comment authors of their comments on their own posts.
1388          *
1389          * By default, comment authors aren't notified of their comments on their own
1390          * posts. This filter allows you to override that.
1391          *
1392          * @since 3.8.0
1393          *
1394          * @param bool $notify     Whether to notify the post author of their own comment.
1395          *                         Default false.
1396          * @param int  $comment_id The comment ID.
1397          */
1398         $notify_author = apply_filters( 'comment_notification_notify_author', false, $comment->comment_ID );
1399
1400         // The comment was left by the author
1401         if ( $author && ! $notify_author && $comment->user_id == $post->post_author ) {
1402                 unset( $emails[ $author->user_email ] );
1403         }
1404
1405         // The author moderated a comment on their own post
1406         if ( $author && ! $notify_author && $post->post_author == get_current_user_id() ) {
1407                 unset( $emails[ $author->user_email ] );
1408         }
1409
1410         // The post author is no longer a member of the blog
1411         if ( $author && ! $notify_author && ! user_can( $post->post_author, 'read_post', $post->ID ) ) {
1412                 unset( $emails[ $author->user_email ] );
1413         }
1414
1415         // If there's no email to send the comment to, bail, otherwise flip array back around for use below
1416         if ( ! count( $emails ) ) {
1417                 return false;
1418         } else {
1419                 $emails = array_flip( $emails );
1420         }
1421
1422         $switched_locale = switch_to_locale( get_locale() );
1423
1424         $comment_author_domain = @gethostbyaddr($comment->comment_author_IP);
1425
1426         // The blogname option is escaped with esc_html on the way into the database in sanitize_option
1427         // we want to reverse this for the plain text arena of emails.
1428         $blogname = wp_specialchars_decode(get_option('blogname'), ENT_QUOTES);
1429         $comment_content = wp_specialchars_decode( $comment->comment_content );
1430
1431         switch ( $comment->comment_type ) {
1432                 case 'trackback':
1433                         /* translators: 1: Post title */
1434                         $notify_message  = sprintf( __( 'New trackback on your post "%s"' ), $post->post_title ) . "\r\n";
1435                         /* translators: 1: Trackback/pingback website name, 2: website IP, 3: website hostname */
1436                         $notify_message .= sprintf( __('Website: %1$s (IP: %2$s, %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
1437                         $notify_message .= sprintf( __( 'URL: %s' ), $comment->comment_author_url ) . "\r\n";
1438                         $notify_message .= sprintf( __( 'Comment: %s' ), "\r\n" . $comment_content ) . "\r\n\r\n";
1439                         $notify_message .= __( 'You can see all trackbacks on this post here:' ) . "\r\n";
1440                         /* translators: 1: blog name, 2: post title */
1441                         $subject = sprintf( __('[%1$s] Trackback: "%2$s"'), $blogname, $post->post_title );
1442                         break;
1443                 case 'pingback':
1444                         /* translators: 1: Post title */
1445                         $notify_message  = sprintf( __( 'New pingback on your post "%s"' ), $post->post_title ) . "\r\n";
1446                         /* translators: 1: Trackback/pingback website name, 2: website IP, 3: website hostname */
1447                         $notify_message .= sprintf( __('Website: %1$s (IP: %2$s, %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
1448                         $notify_message .= sprintf( __( 'URL: %s' ), $comment->comment_author_url ) . "\r\n";
1449                         $notify_message .= sprintf( __( 'Comment: %s' ), "\r\n" . $comment_content ) . "\r\n\r\n";
1450                         $notify_message .= __( 'You can see all pingbacks on this post here:' ) . "\r\n";
1451                         /* translators: 1: blog name, 2: post title */
1452                         $subject = sprintf( __('[%1$s] Pingback: "%2$s"'), $blogname, $post->post_title );
1453                         break;
1454                 default: // Comments
1455                         $notify_message  = sprintf( __( 'New comment on your post "%s"' ), $post->post_title ) . "\r\n";
1456                         /* translators: 1: comment author, 2: author IP, 3: author domain */
1457                         $notify_message .= sprintf( __( 'Author: %1$s (IP: %2$s, %3$s)' ), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
1458                         $notify_message .= sprintf( __( 'Email: %s' ), $comment->comment_author_email ) . "\r\n";
1459                         $notify_message .= sprintf( __( 'URL: %s' ), $comment->comment_author_url ) . "\r\n";
1460                         $notify_message .= sprintf( __('Comment: %s' ), "\r\n" . $comment_content ) . "\r\n\r\n";
1461                         $notify_message .= __( 'You can see all comments on this post here:' ) . "\r\n";
1462                         /* translators: 1: blog name, 2: post title */
1463                         $subject = sprintf( __('[%1$s] Comment: "%2$s"'), $blogname, $post->post_title );
1464                         break;
1465         }
1466         $notify_message .= get_permalink($comment->comment_post_ID) . "#comments\r\n\r\n";
1467         $notify_message .= sprintf( __('Permalink: %s'), get_comment_link( $comment ) ) . "\r\n";
1468
1469         if ( user_can( $post->post_author, 'edit_comment', $comment->comment_ID ) ) {
1470                 if ( EMPTY_TRASH_DAYS ) {
1471                         $notify_message .= sprintf( __( 'Trash it: %s' ), admin_url( "comment.php?action=trash&c={$comment->comment_ID}#wpbody-content" ) ) . "\r\n";
1472                 } else {
1473                         $notify_message .= sprintf( __( 'Delete it: %s' ), admin_url( "comment.php?action=delete&c={$comment->comment_ID}#wpbody-content" ) ) . "\r\n";
1474                 }
1475                 $notify_message .= sprintf( __( 'Spam it: %s' ), admin_url( "comment.php?action=spam&c={$comment->comment_ID}#wpbody-content" ) ) . "\r\n";
1476         }
1477
1478         $wp_email = 'wordpress@' . preg_replace('#^www\.#', '', strtolower($_SERVER['SERVER_NAME']));
1479
1480         if ( '' == $comment->comment_author ) {
1481                 $from = "From: \"$blogname\" <$wp_email>";
1482                 if ( '' != $comment->comment_author_email )
1483                         $reply_to = "Reply-To: $comment->comment_author_email";
1484         } else {
1485                 $from = "From: \"$comment->comment_author\" <$wp_email>";
1486                 if ( '' != $comment->comment_author_email )
1487                         $reply_to = "Reply-To: \"$comment->comment_author_email\" <$comment->comment_author_email>";
1488         }
1489
1490         $message_headers = "$from\n"
1491                 . "Content-Type: text/plain; charset=\"" . get_option('blog_charset') . "\"\n";
1492
1493         if ( isset($reply_to) )
1494                 $message_headers .= $reply_to . "\n";
1495
1496         /**
1497          * Filters the comment notification email text.
1498          *
1499          * @since 1.5.2
1500          *
1501          * @param string $notify_message The comment notification email text.
1502          * @param int    $comment_id     Comment ID.
1503          */
1504         $notify_message = apply_filters( 'comment_notification_text', $notify_message, $comment->comment_ID );
1505
1506         /**
1507          * Filters the comment notification email subject.
1508          *
1509          * @since 1.5.2
1510          *
1511          * @param string $subject    The comment notification email subject.
1512          * @param int    $comment_id Comment ID.
1513          */
1514         $subject = apply_filters( 'comment_notification_subject', $subject, $comment->comment_ID );
1515
1516         /**
1517          * Filters the comment notification email headers.
1518          *
1519          * @since 1.5.2
1520          *
1521          * @param string $message_headers Headers for the comment notification email.
1522          * @param int    $comment_id      Comment ID.
1523          */
1524         $message_headers = apply_filters( 'comment_notification_headers', $message_headers, $comment->comment_ID );
1525
1526         foreach ( $emails as $email ) {
1527                 @wp_mail( $email, wp_specialchars_decode( $subject ), $notify_message, $message_headers );
1528         }
1529
1530         if ( $switched_locale ) {
1531                 restore_previous_locale();
1532         }
1533
1534         return true;
1535 }
1536 endif;
1537
1538 if ( !function_exists('wp_notify_moderator') ) :
1539 /**
1540  * Notifies the moderator of the site about a new comment that is awaiting approval.
1541  *
1542  * @since 1.0.0
1543  *
1544  * @global wpdb $wpdb WordPress database abstraction object.
1545  *
1546  * Uses the {@see 'notify_moderator'} filter to determine whether the site moderator
1547  * should be notified, overriding the site setting.
1548  *
1549  * @param int $comment_id Comment ID.
1550  * @return true Always returns true.
1551  */
1552 function wp_notify_moderator($comment_id) {
1553         global $wpdb;
1554
1555         $maybe_notify = get_option( 'moderation_notify' );
1556
1557         /**
1558          * Filters whether to send the site moderator email notifications, overriding the site setting.
1559          *
1560          * @since 4.4.0
1561          *
1562          * @param bool $maybe_notify Whether to notify blog moderator.
1563          * @param int  $comment_ID   The id of the comment for the notification.
1564          */
1565         $maybe_notify = apply_filters( 'notify_moderator', $maybe_notify, $comment_id );
1566
1567         if ( ! $maybe_notify ) {
1568                 return true;
1569         }
1570
1571         $comment = get_comment($comment_id);
1572         $post = get_post($comment->comment_post_ID);
1573         $user = get_userdata( $post->post_author );
1574         // Send to the administration and to the post author if the author can modify the comment.
1575         $emails = array( get_option( 'admin_email' ) );
1576         if ( $user && user_can( $user->ID, 'edit_comment', $comment_id ) && ! empty( $user->user_email ) ) {
1577                 if ( 0 !== strcasecmp( $user->user_email, get_option( 'admin_email' ) ) )
1578                         $emails[] = $user->user_email;
1579         }
1580
1581         $switched_locale = switch_to_locale( get_locale() );
1582
1583         $comment_author_domain = @gethostbyaddr($comment->comment_author_IP);
1584         $comments_waiting = $wpdb->get_var("SELECT count(comment_ID) FROM $wpdb->comments WHERE comment_approved = '0'");
1585
1586         // The blogname option is escaped with esc_html on the way into the database in sanitize_option
1587         // we want to reverse this for the plain text arena of emails.
1588         $blogname = wp_specialchars_decode(get_option('blogname'), ENT_QUOTES);
1589         $comment_content = wp_specialchars_decode( $comment->comment_content );
1590
1591         switch ( $comment->comment_type ) {
1592                 case 'trackback':
1593                         /* translators: 1: Post title */
1594                         $notify_message  = sprintf( __('A new trackback on the post "%s" is waiting for your approval'), $post->post_title ) . "\r\n";
1595                         $notify_message .= get_permalink($comment->comment_post_ID) . "\r\n\r\n";
1596                         /* translators: 1: Trackback/pingback website name, 2: website IP, 3: website hostname */
1597                         $notify_message .= sprintf( __( 'Website: %1$s (IP: %2$s, %3$s)' ), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
1598                         /* translators: 1: Trackback/pingback/comment author URL */
1599                         $notify_message .= sprintf( __( 'URL: %s' ), $comment->comment_author_url ) . "\r\n";
1600                         $notify_message .= __('Trackback excerpt: ') . "\r\n" . $comment_content . "\r\n\r\n";
1601                         break;
1602                 case 'pingback':
1603                         /* translators: 1: Post title */
1604                         $notify_message  = sprintf( __('A new pingback on the post "%s" is waiting for your approval'), $post->post_title ) . "\r\n";
1605                         $notify_message .= get_permalink($comment->comment_post_ID) . "\r\n\r\n";
1606                         /* translators: 1: Trackback/pingback website name, 2: website IP, 3: website hostname */
1607                         $notify_message .= sprintf( __( 'Website: %1$s (IP: %2$s, %3$s)' ), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
1608                         /* translators: 1: Trackback/pingback/comment author URL */
1609                         $notify_message .= sprintf( __( 'URL: %s' ), $comment->comment_author_url ) . "\r\n";
1610                         $notify_message .= __('Pingback excerpt: ') . "\r\n" . $comment_content . "\r\n\r\n";
1611                         break;
1612                 default: // Comments
1613                         /* translators: 1: Post title */
1614                         $notify_message  = sprintf( __('A new comment on the post "%s" is waiting for your approval'), $post->post_title ) . "\r\n";
1615                         $notify_message .= get_permalink($comment->comment_post_ID) . "\r\n\r\n";
1616                         /* translators: 1: Comment author name, 2: comment author's IP, 3: comment author IP's hostname */
1617                         $notify_message .= sprintf( __( 'Author: %1$s (IP: %2$s, %3$s)' ), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
1618                         /* translators: 1: Comment author URL */
1619                         $notify_message .= sprintf( __( 'Email: %s' ), $comment->comment_author_email ) . "\r\n";
1620                         /* translators: 1: Trackback/pingback/comment author URL */
1621                         $notify_message .= sprintf( __( 'URL: %s' ), $comment->comment_author_url ) . "\r\n";
1622                         /* translators: 1: Comment text */
1623                         $notify_message .= sprintf( __( 'Comment: %s' ), "\r\n" . $comment_content ) . "\r\n\r\n";
1624                         break;
1625         }
1626
1627         /* translators: Comment moderation. 1: Comment action URL */
1628         $notify_message .= sprintf( __( 'Approve it: %s' ), admin_url( "comment.php?action=approve&c={$comment_id}#wpbody-content" ) ) . "\r\n";
1629
1630         if ( EMPTY_TRASH_DAYS ) {
1631                 /* translators: Comment moderation. 1: Comment action URL */
1632                 $notify_message .= sprintf( __( 'Trash it: %s' ), admin_url( "comment.php?action=trash&c={$comment_id}#wpbody-content" ) ) . "\r\n";
1633         } else {
1634                 /* translators: Comment moderation. 1: Comment action URL */
1635                 $notify_message .= sprintf( __( 'Delete it: %s' ), admin_url( "comment.php?action=delete&c={$comment_id}#wpbody-content" ) ) . "\r\n";
1636         }
1637
1638         /* translators: Comment moderation. 1: Comment action URL */
1639         $notify_message .= sprintf( __( 'Spam it: %s' ), admin_url( "comment.php?action=spam&c={$comment_id}#wpbody-content" ) ) . "\r\n";
1640
1641         /* translators: Comment moderation. 1: Number of comments awaiting approval */
1642         $notify_message .= sprintf( _n('Currently %s comment is waiting for approval. Please visit the moderation panel:',
1643                 'Currently %s comments are waiting for approval. Please visit the moderation panel:', $comments_waiting), number_format_i18n($comments_waiting) ) . "\r\n";
1644         $notify_message .= admin_url( "edit-comments.php?comment_status=moderated#wpbody-content" ) . "\r\n";
1645
1646         /* translators: Comment moderation notification email subject. 1: Site name, 2: Post title */
1647         $subject = sprintf( __('[%1$s] Please moderate: "%2$s"'), $blogname, $post->post_title );
1648         $message_headers = '';
1649
1650         /**
1651          * Filters the list of recipients for comment moderation emails.
1652          *
1653          * @since 3.7.0
1654          *
1655          * @param array $emails     List of email addresses to notify for comment moderation.
1656          * @param int   $comment_id Comment ID.
1657          */
1658         $emails = apply_filters( 'comment_moderation_recipients', $emails, $comment_id );
1659
1660         /**
1661          * Filters the comment moderation email text.
1662          *
1663          * @since 1.5.2
1664          *
1665          * @param string $notify_message Text of the comment moderation email.
1666          * @param int    $comment_id     Comment ID.
1667          */
1668         $notify_message = apply_filters( 'comment_moderation_text', $notify_message, $comment_id );
1669
1670         /**
1671          * Filters the comment moderation email subject.
1672          *
1673          * @since 1.5.2
1674          *
1675          * @param string $subject    Subject of the comment moderation email.
1676          * @param int    $comment_id Comment ID.
1677          */
1678         $subject = apply_filters( 'comment_moderation_subject', $subject, $comment_id );
1679
1680         /**
1681          * Filters the comment moderation email headers.
1682          *
1683          * @since 2.8.0
1684          *
1685          * @param string $message_headers Headers for the comment moderation email.
1686          * @param int    $comment_id      Comment ID.
1687          */
1688         $message_headers = apply_filters( 'comment_moderation_headers', $message_headers, $comment_id );
1689
1690         foreach ( $emails as $email ) {
1691                 @wp_mail( $email, wp_specialchars_decode( $subject ), $notify_message, $message_headers );
1692         }
1693
1694         if ( $switched_locale ) {
1695                 restore_previous_locale();
1696         }
1697
1698         return true;
1699 }
1700 endif;
1701
1702 if ( !function_exists('wp_password_change_notification') ) :
1703 /**
1704  * Notify the blog admin of a user changing password, normally via email.
1705  *
1706  * @since 2.7.0
1707  *
1708  * @param WP_User $user User object.
1709  */
1710 function wp_password_change_notification( $user ) {
1711         // send a copy of password change notification to the admin
1712         // but check to see if it's the admin whose password we're changing, and skip this
1713         if ( 0 !== strcasecmp( $user->user_email, get_option( 'admin_email' ) ) ) {
1714                 /* translators: %s: user name */
1715                 $message = sprintf( __( 'Password changed for user: %s' ), $user->user_login ) . "\r\n";
1716                 // The blogname option is escaped with esc_html on the way into the database in sanitize_option
1717                 // we want to reverse this for the plain text arena of emails.
1718                 $blogname = wp_specialchars_decode(get_option('blogname'), ENT_QUOTES);
1719                 /* translators: %s: site title */
1720                 wp_mail( get_option( 'admin_email' ), sprintf( __( '[%s] Password Changed' ), $blogname ), $message );
1721         }
1722 }
1723 endif;
1724
1725 if ( !function_exists('wp_new_user_notification') ) :
1726 /**
1727  * Email login credentials to a newly-registered user.
1728  *
1729  * A new user registration notification is also sent to admin email.
1730  *
1731  * @since 2.0.0
1732  * @since 4.3.0 The `$plaintext_pass` parameter was changed to `$notify`.
1733  * @since 4.3.1 The `$plaintext_pass` parameter was deprecated. `$notify` added as a third parameter.
1734  * @since 4.6.0 The `$notify` parameter accepts 'user' for sending notification only to the user created.
1735  *
1736  * @global wpdb         $wpdb      WordPress database object for queries.
1737  * @global PasswordHash $wp_hasher Portable PHP password hashing framework instance.
1738  *
1739  * @param int    $user_id    User ID.
1740  * @param null   $deprecated Not used (argument deprecated).
1741  * @param string $notify     Optional. Type of notification that should happen. Accepts 'admin' or an empty
1742  *                           string (admin only), 'user', or 'both' (admin and user). Default empty.
1743  */
1744 function wp_new_user_notification( $user_id, $deprecated = null, $notify = '' ) {
1745         if ( $deprecated !== null ) {
1746                 _deprecated_argument( __FUNCTION__, '4.3.1' );
1747         }
1748
1749         global $wpdb, $wp_hasher;
1750         $user = get_userdata( $user_id );
1751
1752         // The blogname option is escaped with esc_html on the way into the database in sanitize_option
1753         // we want to reverse this for the plain text arena of emails.
1754         $blogname = wp_specialchars_decode(get_option('blogname'), ENT_QUOTES);
1755
1756         if ( 'user' !== $notify ) {
1757                 $switched_locale = switch_to_locale( get_locale() );
1758                 $message  = sprintf( __( 'New user registration on your site %s:' ), $blogname ) . "\r\n\r\n";
1759                 $message .= sprintf( __( 'Username: %s' ), $user->user_login ) . "\r\n\r\n";
1760                 $message .= sprintf( __( 'Email: %s' ), $user->user_email ) . "\r\n";
1761
1762                 @wp_mail( get_option( 'admin_email' ), sprintf( __( '[%s] New User Registration' ), $blogname ), $message );
1763
1764                 if ( $switched_locale ) {
1765                         restore_previous_locale();
1766                 }
1767         }
1768
1769         // `$deprecated was pre-4.3 `$plaintext_pass`. An empty `$plaintext_pass` didn't sent a user notification.
1770         if ( 'admin' === $notify || ( empty( $deprecated ) && empty( $notify ) ) ) {
1771                 return;
1772         }
1773
1774         // Generate something random for a password reset key.
1775         $key = wp_generate_password( 20, false );
1776
1777         /** This action is documented in wp-login.php */
1778         do_action( 'retrieve_password_key', $user->user_login, $key );
1779
1780         // Now insert the key, hashed, into the DB.
1781         if ( empty( $wp_hasher ) ) {
1782                 $wp_hasher = new PasswordHash( 8, true );
1783         }
1784         $hashed = time() . ':' . $wp_hasher->HashPassword( $key );
1785         $wpdb->update( $wpdb->users, array( 'user_activation_key' => $hashed ), array( 'user_login' => $user->user_login ) );
1786
1787         $switched_locale = switch_to_locale( get_user_locale( $user ) );
1788
1789         $message = sprintf(__('Username: %s'), $user->user_login) . "\r\n\r\n";
1790         $message .= __('To set your password, visit the following address:') . "\r\n\r\n";
1791         $message .= '<' . network_site_url("wp-login.php?action=rp&key=$key&login=" . rawurlencode($user->user_login), 'login') . ">\r\n\r\n";
1792
1793         $message .= wp_login_url() . "\r\n";
1794
1795         wp_mail($user->user_email, sprintf(__('[%s] Your username and password info'), $blogname), $message);
1796
1797         if ( $switched_locale ) {
1798                 restore_previous_locale();
1799         }
1800 }
1801 endif;
1802
1803 if ( !function_exists('wp_nonce_tick') ) :
1804 /**
1805  * Get the time-dependent variable for nonce creation.
1806  *
1807  * A nonce has a lifespan of two ticks. Nonces in their second tick may be
1808  * updated, e.g. by autosave.
1809  *
1810  * @since 2.5.0
1811  *
1812  * @return float Float value rounded up to the next highest integer.
1813  */
1814 function wp_nonce_tick() {
1815         /**
1816          * Filters the lifespan of nonces in seconds.
1817          *
1818          * @since 2.5.0
1819          *
1820          * @param int $lifespan Lifespan of nonces in seconds. Default 86,400 seconds, or one day.
1821          */
1822         $nonce_life = apply_filters( 'nonce_life', DAY_IN_SECONDS );
1823
1824         return ceil(time() / ( $nonce_life / 2 ));
1825 }
1826 endif;
1827
1828 if ( !function_exists('wp_verify_nonce') ) :
1829 /**
1830  * Verify that correct nonce was used with time limit.
1831  *
1832  * The user is given an amount of time to use the token, so therefore, since the
1833  * UID and $action remain the same, the independent variable is the time.
1834  *
1835  * @since 2.0.3
1836  *
1837  * @param string     $nonce  Nonce that was used in the form to verify
1838  * @param string|int $action Should give context to what is taking place and be the same when nonce was created.
1839  * @return false|int False if the nonce is invalid, 1 if the nonce is valid and generated between
1840  *                   0-12 hours ago, 2 if the nonce is valid and generated between 12-24 hours ago.
1841  */
1842 function wp_verify_nonce( $nonce, $action = -1 ) {
1843         $nonce = (string) $nonce;
1844         $user = wp_get_current_user();
1845         $uid = (int) $user->ID;
1846         if ( ! $uid ) {
1847                 /**
1848                  * Filters whether the user who generated the nonce is logged out.
1849                  *
1850                  * @since 3.5.0
1851                  *
1852                  * @param int    $uid    ID of the nonce-owning user.
1853                  * @param string $action The nonce action.
1854                  */
1855                 $uid = apply_filters( 'nonce_user_logged_out', $uid, $action );
1856         }
1857
1858         if ( empty( $nonce ) ) {
1859                 return false;
1860         }
1861
1862         $token = wp_get_session_token();
1863         $i = wp_nonce_tick();
1864
1865         // Nonce generated 0-12 hours ago
1866         $expected = substr( wp_hash( $i . '|' . $action . '|' . $uid . '|' . $token, 'nonce'), -12, 10 );
1867         if ( hash_equals( $expected, $nonce ) ) {
1868                 return 1;
1869         }
1870
1871         // Nonce generated 12-24 hours ago
1872         $expected = substr( wp_hash( ( $i - 1 ) . '|' . $action . '|' . $uid . '|' . $token, 'nonce' ), -12, 10 );
1873         if ( hash_equals( $expected, $nonce ) ) {
1874                 return 2;
1875         }
1876
1877         /**
1878          * Fires when nonce verification fails.
1879          *
1880          * @since 4.4.0
1881          *
1882          * @param string     $nonce  The invalid nonce.
1883          * @param string|int $action The nonce action.
1884          * @param WP_User    $user   The current user object.
1885          * @param string     $token  The user's session token.
1886          */
1887         do_action( 'wp_verify_nonce_failed', $nonce, $action, $user, $token );
1888
1889         // Invalid nonce
1890         return false;
1891 }
1892 endif;
1893
1894 if ( !function_exists('wp_create_nonce') ) :
1895 /**
1896  * Creates a cryptographic token tied to a specific action, user, user session,
1897  * and window of time.
1898  *
1899  * @since 2.0.3
1900  * @since 4.0.0 Session tokens were integrated with nonce creation
1901  *
1902  * @param string|int $action Scalar value to add context to the nonce.
1903  * @return string The token.
1904  */
1905 function wp_create_nonce($action = -1) {
1906         $user = wp_get_current_user();
1907         $uid = (int) $user->ID;
1908         if ( ! $uid ) {
1909                 /** This filter is documented in wp-includes/pluggable.php */
1910                 $uid = apply_filters( 'nonce_user_logged_out', $uid, $action );
1911         }
1912
1913         $token = wp_get_session_token();
1914         $i = wp_nonce_tick();
1915
1916         return substr( wp_hash( $i . '|' . $action . '|' . $uid . '|' . $token, 'nonce' ), -12, 10 );
1917 }
1918 endif;
1919
1920 if ( !function_exists('wp_salt') ) :
1921 /**
1922  * Get salt to add to hashes.
1923  *
1924  * Salts are created using secret keys. Secret keys are located in two places:
1925  * in the database and in the wp-config.php file. The secret key in the database
1926  * is randomly generated and will be appended to the secret keys in wp-config.php.
1927  *
1928  * The secret keys in wp-config.php should be updated to strong, random keys to maximize
1929  * security. Below is an example of how the secret key constants are defined.
1930  * Do not paste this example directly into wp-config.php. Instead, have a
1931  * {@link https://api.wordpress.org/secret-key/1.1/salt/ secret key created} just
1932  * for you.
1933  *
1934  *     define('AUTH_KEY',         ' Xakm<o xQy rw4EMsLKM-?!T+,PFF})H4lzcW57AF0U@N@< >M%G4Yt>f`z]MON');
1935  *     define('SECURE_AUTH_KEY',  'LzJ}op]mr|6+![P}Ak:uNdJCJZd>(Hx.-Mh#Tz)pCIU#uGEnfFz|f ;;eU%/U^O~');
1936  *     define('LOGGED_IN_KEY',    '|i|Ux`9<p-h$aFf(qnT:sDO:D1P^wZ$$/Ra@miTJi9G;ddp_<q}6H1)o|a +&JCM');
1937  *     define('NONCE_KEY',        '%:R{[P|,s.KuMltH5}cI;/k<Gx~j!f0I)m_sIyu+&NJZ)-iO>z7X>QYR0Z_XnZ@|');
1938  *     define('AUTH_SALT',        'eZyT)-Naw]F8CwA*VaW#q*|.)g@o}||wf~@C-YSt}(dh_r6EbI#A,y|nU2{B#JBW');
1939  *     define('SECURE_AUTH_SALT', '!=oLUTXh,QW=H `}`L|9/^4-3 STz},T(w}W<I`.JjPi)<Bmf1v,HpGe}T1:Xt7n');
1940  *     define('LOGGED_IN_SALT',   '+XSqHc;@Q*K_b|Z?NC[3H!!EONbh.n<+=uKR:>*c(u`g~EJBf#8u#R{mUEZrozmm');
1941  *     define('NONCE_SALT',       'h`GXHhD>SLWVfg1(1(N{;.V!MoE(SfbA_ksP@&`+AycHcAV$+?@3q+rxV{%^VyKT');
1942  *
1943  * Salting passwords helps against tools which has stored hashed values of
1944  * common dictionary strings. The added values makes it harder to crack.
1945  *
1946  * @since 2.5.0
1947  *
1948  * @link https://api.wordpress.org/secret-key/1.1/salt/ Create secrets for wp-config.php
1949  *
1950  * @staticvar array $cached_salts
1951  * @staticvar array $duplicated_keys
1952  *
1953  * @param string $scheme Authentication scheme (auth, secure_auth, logged_in, nonce)
1954  * @return string Salt value
1955  */
1956 function wp_salt( $scheme = 'auth' ) {
1957         static $cached_salts = array();
1958         if ( isset( $cached_salts[ $scheme ] ) ) {
1959                 /**
1960                  * Filters the WordPress salt.
1961                  *
1962                  * @since 2.5.0
1963                  *
1964                  * @param string $cached_salt Cached salt for the given scheme.
1965                  * @param string $scheme      Authentication scheme. Values include 'auth',
1966                  *                            'secure_auth', 'logged_in', and 'nonce'.
1967                  */
1968                 return apply_filters( 'salt', $cached_salts[ $scheme ], $scheme );
1969         }
1970
1971         static $duplicated_keys;
1972         if ( null === $duplicated_keys ) {
1973                 $duplicated_keys = array( 'put your unique phrase here' => true );
1974                 foreach ( array( 'AUTH', 'SECURE_AUTH', 'LOGGED_IN', 'NONCE', 'SECRET' ) as $first ) {
1975                         foreach ( array( 'KEY', 'SALT' ) as $second ) {
1976                                 if ( ! defined( "{$first}_{$second}" ) ) {
1977                                         continue;
1978                                 }
1979                                 $value = constant( "{$first}_{$second}" );
1980                                 $duplicated_keys[ $value ] = isset( $duplicated_keys[ $value ] );
1981                         }
1982                 }
1983         }
1984
1985         $values = array(
1986                 'key' => '',
1987                 'salt' => ''
1988         );
1989         if ( defined( 'SECRET_KEY' ) && SECRET_KEY && empty( $duplicated_keys[ SECRET_KEY ] ) ) {
1990                 $values['key'] = SECRET_KEY;
1991         }
1992         if ( 'auth' == $scheme && defined( 'SECRET_SALT' ) && SECRET_SALT && empty( $duplicated_keys[ SECRET_SALT ] ) ) {
1993                 $values['salt'] = SECRET_SALT;
1994         }
1995
1996         if ( in_array( $scheme, array( 'auth', 'secure_auth', 'logged_in', 'nonce' ) ) ) {
1997                 foreach ( array( 'key', 'salt' ) as $type ) {
1998                         $const = strtoupper( "{$scheme}_{$type}" );
1999                         if ( defined( $const ) && constant( $const ) && empty( $duplicated_keys[ constant( $const ) ] ) ) {
2000                                 $values[ $type ] = constant( $const );
2001                         } elseif ( ! $values[ $type ] ) {
2002                                 $values[ $type ] = get_site_option( "{$scheme}_{$type}" );
2003                                 if ( ! $values[ $type ] ) {
2004                                         $values[ $type ] = wp_generate_password( 64, true, true );
2005                                         update_site_option( "{$scheme}_{$type}", $values[ $type ] );
2006                                 }
2007                         }
2008                 }
2009         } else {
2010                 if ( ! $values['key'] ) {
2011                         $values['key'] = get_site_option( 'secret_key' );
2012                         if ( ! $values['key'] ) {
2013                                 $values['key'] = wp_generate_password( 64, true, true );
2014                                 update_site_option( 'secret_key', $values['key'] );
2015                         }
2016                 }
2017                 $values['salt'] = hash_hmac( 'md5', $scheme, $values['key'] );
2018         }
2019
2020         $cached_salts[ $scheme ] = $values['key'] . $values['salt'];
2021
2022         /** This filter is documented in wp-includes/pluggable.php */
2023         return apply_filters( 'salt', $cached_salts[ $scheme ], $scheme );
2024 }
2025 endif;
2026
2027 if ( !function_exists('wp_hash') ) :
2028 /**
2029  * Get hash of given string.
2030  *
2031  * @since 2.0.3
2032  *
2033  * @param string $data   Plain text to hash
2034  * @param string $scheme Authentication scheme (auth, secure_auth, logged_in, nonce)
2035  * @return string Hash of $data
2036  */
2037 function wp_hash($data, $scheme = 'auth') {
2038         $salt = wp_salt($scheme);
2039
2040         return hash_hmac('md5', $data, $salt);
2041 }
2042 endif;
2043
2044 if ( !function_exists('wp_hash_password') ) :
2045 /**
2046  * Create a hash (encrypt) of a plain text password.
2047  *
2048  * For integration with other applications, this function can be overwritten to
2049  * instead use the other package password checking algorithm.
2050  *
2051  * @since 2.5.0
2052  *
2053  * @global PasswordHash $wp_hasher PHPass object
2054  *
2055  * @param string $password Plain text user password to hash
2056  * @return string The hash string of the password
2057  */
2058 function wp_hash_password($password) {
2059         global $wp_hasher;
2060
2061         if ( empty($wp_hasher) ) {
2062                 // By default, use the portable hash from phpass
2063                 $wp_hasher = new PasswordHash(8, true);
2064         }
2065
2066         return $wp_hasher->HashPassword( trim( $password ) );
2067 }
2068 endif;
2069
2070 if ( !function_exists('wp_check_password') ) :
2071 /**
2072  * Checks the plaintext password against the encrypted Password.
2073  *
2074  * Maintains compatibility between old version and the new cookie authentication
2075  * protocol using PHPass library. The $hash parameter is the encrypted password
2076  * and the function compares the plain text password when encrypted similarly
2077  * against the already encrypted password to see if they match.
2078  *
2079  * For integration with other applications, this function can be overwritten to
2080  * instead use the other package password checking algorithm.
2081  *
2082  * @since 2.5.0
2083  *
2084  * @global PasswordHash $wp_hasher PHPass object used for checking the password
2085  *      against the $hash + $password
2086  * @uses PasswordHash::CheckPassword
2087  *
2088  * @param string     $password Plaintext user's password
2089  * @param string     $hash     Hash of the user's password to check against.
2090  * @param string|int $user_id  Optional. User ID.
2091  * @return bool False, if the $password does not match the hashed password
2092  */
2093 function wp_check_password($password, $hash, $user_id = '') {
2094         global $wp_hasher;
2095
2096         // If the hash is still md5...
2097         if ( strlen($hash) <= 32 ) {
2098                 $check = hash_equals( $hash, md5( $password ) );
2099                 if ( $check && $user_id ) {
2100                         // Rehash using new hash.
2101                         wp_set_password($password, $user_id);
2102                         $hash = wp_hash_password($password);
2103                 }
2104
2105                 /**
2106                  * Filters whether the plaintext password matches the encrypted password.
2107                  *
2108                  * @since 2.5.0
2109                  *
2110                  * @param bool       $check    Whether the passwords match.
2111                  * @param string     $password The plaintext password.
2112                  * @param string     $hash     The hashed password.
2113                  * @param string|int $user_id  User ID. Can be empty.
2114                  */
2115                 return apply_filters( 'check_password', $check, $password, $hash, $user_id );
2116         }
2117
2118         // If the stored hash is longer than an MD5, presume the
2119         // new style phpass portable hash.
2120         if ( empty($wp_hasher) ) {
2121                 // By default, use the portable hash from phpass
2122                 $wp_hasher = new PasswordHash(8, true);
2123         }
2124
2125         $check = $wp_hasher->CheckPassword($password, $hash);
2126
2127         /** This filter is documented in wp-includes/pluggable.php */
2128         return apply_filters( 'check_password', $check, $password, $hash, $user_id );
2129 }
2130 endif;
2131
2132 if ( !function_exists('wp_generate_password') ) :
2133 /**
2134  * Generates a random password drawn from the defined set of characters.
2135  *
2136  * @since 2.5.0
2137  *
2138  * @param int  $length              Optional. The length of password to generate. Default 12.
2139  * @param bool $special_chars       Optional. Whether to include standard special characters.
2140  *                                  Default true.
2141  * @param bool $extra_special_chars Optional. Whether to include other special characters.
2142  *                                  Used when generating secret keys and salts. Default false.
2143  * @return string The random password.
2144  */
2145 function wp_generate_password( $length = 12, $special_chars = true, $extra_special_chars = false ) {
2146         $chars = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789';
2147         if ( $special_chars )
2148                 $chars .= '!@#$%^&*()';
2149         if ( $extra_special_chars )
2150                 $chars .= '-_ []{}<>~`+=,.;:/?|';
2151
2152         $password = '';
2153         for ( $i = 0; $i < $length; $i++ ) {
2154                 $password .= substr($chars, wp_rand(0, strlen($chars) - 1), 1);
2155         }
2156
2157         /**
2158          * Filters the randomly-generated password.
2159          *
2160          * @since 3.0.0
2161          *
2162          * @param string $password The generated password.
2163          */
2164         return apply_filters( 'random_password', $password );
2165 }
2166 endif;
2167
2168 if ( !function_exists('wp_rand') ) :
2169 /**
2170  * Generates a random number
2171  *
2172  * @since 2.6.2
2173  * @since 4.4.0 Uses PHP7 random_int() or the random_compat library if available.
2174  *
2175  * @global string $rnd_value
2176  * @staticvar string $seed
2177  * @staticvar bool $external_rand_source_available
2178  *
2179  * @param int $min Lower limit for the generated number
2180  * @param int $max Upper limit for the generated number
2181  * @return int A random number between min and max
2182  */
2183 function wp_rand( $min = 0, $max = 0 ) {
2184         global $rnd_value;
2185
2186         // 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.
2187         $max_random_number = 3000000000 === 2147483647 ? (float) "4294967295" : 4294967295; // 4294967295 = 0xffffffff
2188
2189         // We only handle Ints, floats are truncated to their integer value.
2190         $min = (int) $min;
2191         $max = (int) $max;
2192
2193         // Use PHP's CSPRNG, or a compatible method
2194         static $use_random_int_functionality = true;
2195         if ( $use_random_int_functionality ) {
2196                 try {
2197                         $_max = ( 0 != $max ) ? $max : $max_random_number;
2198                         // wp_rand() can accept arguments in either order, PHP cannot.
2199                         $_max = max( $min, $_max );
2200                         $_min = min( $min, $_max );
2201                         $val = random_int( $_min, $_max );
2202                         if ( false !== $val ) {
2203                                 return absint( $val );
2204                         } else {
2205                                 $use_random_int_functionality = false;
2206                         }
2207                 } catch ( Error $e ) {
2208                         $use_random_int_functionality = false;
2209                 } catch ( Exception $e ) {
2210                         $use_random_int_functionality = false;
2211                 }
2212         }
2213
2214         // Reset $rnd_value after 14 uses
2215         // 32(md5) + 40(sha1) + 40(sha1) / 8 = 14 random numbers from $rnd_value
2216         if ( strlen($rnd_value) < 8 ) {
2217                 if ( defined( 'WP_SETUP_CONFIG' ) )
2218                         static $seed = '';
2219                 else
2220                         $seed = get_transient('random_seed');
2221                 $rnd_value = md5( uniqid(microtime() . mt_rand(), true ) . $seed );
2222                 $rnd_value .= sha1($rnd_value);
2223                 $rnd_value .= sha1($rnd_value . $seed);
2224                 $seed = md5($seed . $rnd_value);
2225                 if ( ! defined( 'WP_SETUP_CONFIG' ) && ! defined( 'WP_INSTALLING' ) ) {
2226                         set_transient( 'random_seed', $seed );
2227                 }
2228         }
2229
2230         // Take the first 8 digits for our value
2231         $value = substr($rnd_value, 0, 8);
2232
2233         // Strip the first eight, leaving the remainder for the next call to wp_rand().
2234         $rnd_value = substr($rnd_value, 8);
2235
2236         $value = abs(hexdec($value));
2237
2238         // Reduce the value to be within the min - max range
2239         if ( $max != 0 )
2240                 $value = $min + ( $max - $min + 1 ) * $value / ( $max_random_number + 1 );
2241
2242         return abs(intval($value));
2243 }
2244 endif;
2245
2246 if ( !function_exists('wp_set_password') ) :
2247 /**
2248  * Updates the user's password with a new encrypted one.
2249  *
2250  * For integration with other applications, this function can be overwritten to
2251  * instead use the other package password checking algorithm.
2252  *
2253  * Please note: This function should be used sparingly and is really only meant for single-time
2254  * application. Leveraging this improperly in a plugin or theme could result in an endless loop
2255  * of password resets if precautions are not taken to ensure it does not execute on every page load.
2256  *
2257  * @since 2.5.0
2258  *
2259  * @global wpdb $wpdb WordPress database abstraction object.
2260  *
2261  * @param string $password The plaintext new user password
2262  * @param int    $user_id  User ID
2263  */
2264 function wp_set_password( $password, $user_id ) {
2265         global $wpdb;
2266
2267         $hash = wp_hash_password( $password );
2268         $wpdb->update($wpdb->users, array('user_pass' => $hash, 'user_activation_key' => ''), array('ID' => $user_id) );
2269
2270         wp_cache_delete($user_id, 'users');
2271 }
2272 endif;
2273
2274 if ( !function_exists( 'get_avatar' ) ) :
2275 /**
2276  * Retrieve the avatar `<img>` tag for a user, email address, MD5 hash, comment, or post.
2277  *
2278  * @since 2.5.0
2279  * @since 4.2.0 Optional `$args` parameter added.
2280  *
2281  * @param mixed $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash,
2282  *                           user email, WP_User object, WP_Post object, or WP_Comment object.
2283  * @param int    $size       Optional. Height and width of the avatar image file in pixels. Default 96.
2284  * @param string $default    Optional. URL for the default image or a default type. Accepts '404'
2285  *                           (return a 404 instead of a default image), 'retro' (8bit), 'monsterid'
2286  *                           (monster), 'wavatar' (cartoon face), 'indenticon' (the "quilt"),
2287  *                           'mystery', 'mm', or 'mysteryman' (The Oyster Man), 'blank' (transparent GIF),
2288  *                           or 'gravatar_default' (the Gravatar logo). Default is the value of the
2289  *                           'avatar_default' option, with a fallback of 'mystery'.
2290  * @param string $alt        Optional. Alternative text to use in &lt;img&gt; tag. Default empty.
2291  * @param array  $args       {
2292  *     Optional. Extra arguments to retrieve the avatar.
2293  *
2294  *     @type int          $height        Display height of the avatar in pixels. Defaults to $size.
2295  *     @type int          $width         Display width of the avatar in pixels. Defaults to $size.
2296  *     @type bool         $force_default Whether to always show the default image, never the Gravatar. Default false.
2297  *     @type string       $rating        What rating to display avatars up to. Accepts 'G', 'PG', 'R', 'X', and are
2298  *                                       judged in that order. Default is the value of the 'avatar_rating' option.
2299  *     @type string       $scheme        URL scheme to use. See set_url_scheme() for accepted values.
2300  *                                       Default null.
2301  *     @type array|string $class         Array or string of additional classes to add to the &lt;img&gt; element.
2302  *                                       Default null.
2303  *     @type bool         $force_display Whether to always show the avatar - ignores the show_avatars option.
2304  *                                       Default false.
2305  *     @type string       $extra_attr    HTML attributes to insert in the IMG element. Is not sanitized. Default empty.
2306  * }
2307  * @return false|string `<img>` tag for the user's avatar. False on failure.
2308  */
2309 function get_avatar( $id_or_email, $size = 96, $default = '', $alt = '', $args = null ) {
2310         $defaults = array(
2311                 // get_avatar_data() args.
2312                 'size'          => 96,
2313                 'height'        => null,
2314                 'width'         => null,
2315                 'default'       => get_option( 'avatar_default', 'mystery' ),
2316                 'force_default' => false,
2317                 'rating'        => get_option( 'avatar_rating' ),
2318                 'scheme'        => null,
2319                 'alt'           => '',
2320                 'class'         => null,
2321                 'force_display' => false,
2322                 'extra_attr'    => '',
2323         );
2324
2325         if ( empty( $args ) ) {
2326                 $args = array();
2327         }
2328
2329         $args['size']    = (int) $size;
2330         $args['default'] = $default;
2331         $args['alt']     = $alt;
2332
2333         $args = wp_parse_args( $args, $defaults );
2334
2335         if ( empty( $args['height'] ) ) {
2336                 $args['height'] = $args['size'];
2337         }
2338         if ( empty( $args['width'] ) ) {
2339                 $args['width'] = $args['size'];
2340         }
2341
2342         if ( is_object( $id_or_email ) && isset( $id_or_email->comment_ID ) ) {
2343                 $id_or_email = get_comment( $id_or_email );
2344         }
2345
2346         /**
2347          * Filters whether to retrieve the avatar URL early.
2348          *
2349          * Passing a non-null value will effectively short-circuit get_avatar(), passing
2350          * the value through the {@see 'get_avatar'} filter and returning early.
2351          *
2352          * @since 4.2.0
2353          *
2354          * @param string $avatar      HTML for the user's avatar. Default null.
2355          * @param mixed  $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash,
2356          *                            user email, WP_User object, WP_Post object, or WP_Comment object.
2357          * @param array  $args        Arguments passed to get_avatar_url(), after processing.
2358          */
2359         $avatar = apply_filters( 'pre_get_avatar', null, $id_or_email, $args );
2360
2361         if ( ! is_null( $avatar ) ) {
2362                 /** This filter is documented in wp-includes/pluggable.php */
2363                 return apply_filters( 'get_avatar', $avatar, $id_or_email, $args['size'], $args['default'], $args['alt'], $args );
2364         }
2365
2366         if ( ! $args['force_display'] && ! get_option( 'show_avatars' ) ) {
2367                 return false;
2368         }
2369
2370         $url2x = get_avatar_url( $id_or_email, array_merge( $args, array( 'size' => $args['size'] * 2 ) ) );
2371
2372         $args = get_avatar_data( $id_or_email, $args );
2373
2374         $url = $args['url'];
2375
2376         if ( ! $url || is_wp_error( $url ) ) {
2377                 return false;
2378         }
2379
2380         $class = array( 'avatar', 'avatar-' . (int) $args['size'], 'photo' );
2381
2382         if ( ! $args['found_avatar'] || $args['force_default'] ) {
2383                 $class[] = 'avatar-default';
2384         }
2385
2386         if ( $args['class'] ) {
2387                 if ( is_array( $args['class'] ) ) {
2388                         $class = array_merge( $class, $args['class'] );
2389                 } else {
2390                         $class[] = $args['class'];
2391                 }
2392         }
2393
2394         $avatar = sprintf(
2395                 "<img alt='%s' src='%s' srcset='%s' class='%s' height='%d' width='%d' %s/>",
2396                 esc_attr( $args['alt'] ),
2397                 esc_url( $url ),
2398                 esc_attr( "$url2x 2x" ),
2399                 esc_attr( join( ' ', $class ) ),
2400                 (int) $args['height'],
2401                 (int) $args['width'],
2402                 $args['extra_attr']
2403         );
2404
2405         /**
2406          * Filters the avatar to retrieve.
2407          *
2408          * @since 2.5.0
2409          * @since 4.2.0 The `$args` parameter was added.
2410          *
2411          * @param string $avatar      &lt;img&gt; tag for the user's avatar.
2412          * @param mixed  $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash,
2413          *                            user email, WP_User object, WP_Post object, or WP_Comment object.
2414          * @param int    $size        Square avatar width and height in pixels to retrieve.
2415          * @param string $alt         Alternative text to use in the avatar image tag.
2416          *                                       Default empty.
2417          * @param array  $args        Arguments passed to get_avatar_data(), after processing.
2418          */
2419         return apply_filters( 'get_avatar', $avatar, $id_or_email, $args['size'], $args['default'], $args['alt'], $args );
2420 }
2421 endif;
2422
2423 if ( !function_exists( 'wp_text_diff' ) ) :
2424 /**
2425  * Displays a human readable HTML representation of the difference between two strings.
2426  *
2427  * The Diff is available for getting the changes between versions. The output is
2428  * HTML, so the primary use is for displaying the changes. If the two strings
2429  * are equivalent, then an empty string will be returned.
2430  *
2431  * The arguments supported and can be changed are listed below.
2432  *
2433  * 'title' : Default is an empty string. Titles the diff in a manner compatible
2434  *              with the output.
2435  * 'title_left' : Default is an empty string. Change the HTML to the left of the
2436  *              title.
2437  * 'title_right' : Default is an empty string. Change the HTML to the right of
2438  *              the title.
2439  *
2440  * @since 2.6.0
2441  *
2442  * @see wp_parse_args() Used to change defaults to user defined settings.
2443  * @uses Text_Diff
2444  * @uses WP_Text_Diff_Renderer_Table
2445  *
2446  * @param string       $left_string  "old" (left) version of string
2447  * @param string       $right_string "new" (right) version of string
2448  * @param string|array $args         Optional. Change 'title', 'title_left', and 'title_right' defaults.
2449  * @return string Empty string if strings are equivalent or HTML with differences.
2450  */
2451 function wp_text_diff( $left_string, $right_string, $args = null ) {
2452         $defaults = array( 'title' => '', 'title_left' => '', 'title_right' => '' );
2453         $args = wp_parse_args( $args, $defaults );
2454
2455         if ( ! class_exists( 'WP_Text_Diff_Renderer_Table', false ) )
2456                 require( ABSPATH . WPINC . '/wp-diff.php' );
2457
2458         $left_string  = normalize_whitespace($left_string);
2459         $right_string = normalize_whitespace($right_string);
2460
2461         $left_lines  = explode("\n", $left_string);
2462         $right_lines = explode("\n", $right_string);
2463         $text_diff = new Text_Diff($left_lines, $right_lines);
2464         $renderer  = new WP_Text_Diff_Renderer_Table( $args );
2465         $diff = $renderer->render($text_diff);
2466
2467         if ( !$diff )
2468                 return '';
2469
2470         $r  = "<table class='diff'>\n";
2471
2472         if ( ! empty( $args[ 'show_split_view' ] ) ) {
2473                 $r .= "<col class='content diffsplit left' /><col class='content diffsplit middle' /><col class='content diffsplit right' />";
2474         } else {
2475                 $r .= "<col class='content' />";
2476         }
2477
2478         if ( $args['title'] || $args['title_left'] || $args['title_right'] )
2479                 $r .= "<thead>";
2480         if ( $args['title'] )
2481                 $r .= "<tr class='diff-title'><th colspan='4'>$args[title]</th></tr>\n";
2482         if ( $args['title_left'] || $args['title_right'] ) {
2483                 $r .= "<tr class='diff-sub-title'>\n";
2484                 $r .= "\t<td></td><th>$args[title_left]</th>\n";
2485                 $r .= "\t<td></td><th>$args[title_right]</th>\n";
2486                 $r .= "</tr>\n";
2487         }
2488         if ( $args['title'] || $args['title_left'] || $args['title_right'] )
2489                 $r .= "</thead>\n";
2490
2491         $r .= "<tbody>\n$diff\n</tbody>\n";
2492         $r .= "</table>";
2493
2494         return $r;
2495 }
2496 endif;
2497