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