wp-includes/pluggable.php

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