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