[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-includes/ -> pluggable.php (source)

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


Generated: Tue Jan 21 01:00:03 2020 Cross-referenced by PHPXref 0.7.1