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