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