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