ayE7d5vi

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}
971endif;
972
973if ( !function_exists('is_user_logged_in') ) :
974/**
975 * Checks if the current visitor is a logged in user.
976 *
977 * @since 2.0.0
978 *
979 * @return bool True if user is logged in, false if not logged in.
980 */
981function is_user_logged_in() {
982	$user = wp_get_current_user();
983
984	return $user->exists();
985}
986endif;
987
988if ( !function_exists('auth_redirect') ) :
989/**
990 * Checks if a user is logged in, if not it redirects them to the login page.
991 *
992 * @since 1.5.0
993 */
994function auth_redirect() {
995	// Checks if a user is logged in, if not redirects them to the login page
996
997	$secure = ( is_ssl() || force_ssl_admin() );
998
999	/**
1000	 * Filters whether to use a secure authentication redirect.
1001	 *
1002	 * @since 3.1.0
1003	 *
1004	 * @param bool $secure Whether to use a secure authentication redirect. Default false.
1005	 */
1006	$secure = apply_filters( 'secure_auth_redirect', $secure );
1007
1008	// If https is required and request is http, redirect
1009	if ( $secure && !is_ssl() && false !== strpos($_SERVER['REQUEST_URI'], 'wp-admin') ) {
1010		if ( 0 === strpos( $_SERVER['REQUEST_URI'], 'http' ) ) {
1011			wp_redirect( set_url_scheme( $_SERVER['REQUEST_URI'], 'https' ) );
1012			exit();
1013		} else {
1014			wp_redirect( 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );
1015			exit();
1016		}
1017	}
1018
1019	/**
1020	 * Filters the authentication redirect scheme.
1021	 *
1022	 * @since 2.9.0
1023	 *
1024	 * @param string $scheme Authentication redirect scheme. Default empty.
1025	 */
1026	$scheme = apply_filters( 'auth_redirect_scheme', '' );
1027
1028	if ( $user_id = wp_validate_auth_cookie( '',  $scheme) ) {
1029		/**
1030		 * Fires before the authentication redirect.
1031		 *
1032		 * @since 2.8.0
1033		 *
1034		 * @param int $user_id User ID.
1035		 */
1036		do_action( 'auth_redirect', $user_id );
1037
1038		// If the user wants ssl but the session is not ssl, redirect.
1039		if ( !$secure && get_user_option('use_ssl', $user_id) && false !== strpos($_SERVER['REQUEST_URI'], 'wp-admin') ) {
1040			if ( 0 === strpos( $_SERVER['REQUEST_URI'], 'http' ) ) {
1041				wp_redirect( set_url_scheme( $_SERVER['REQUEST_URI'], 'https' ) );
1042				exit();
1043			} else {
1044				wp_redirect( 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );
1045				exit();
1046			}
1047		}
1048
1049		return;  // The cookie is good so we're done
1050	}
1051
1052	// The cookie is no good so force login
1053	nocache_headers();
1054
1055	$redirect = ( strpos( $_SERVER['REQUEST_URI'], '/options.php' ) && wp_get_referer() ) ? wp_get_referer() : set_url_scheme( 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );
1056
1057	$login_url = wp_login_url($redirect, true);
1058
1059	wp_redirect($login_url);
1060	exit();
1061}
1062endif;
1063
1064if ( !function_exists('check_admin_referer') ) :
1065/**
1066 * Makes sure that a user was referred from another admin page.
1067 *
1068 * To avoid security exploits.
1069 *
1070 * @since 1.2.0
1071 *
1072 * @param int|string $action    Action nonce.
1073 * @param string     $query_arg Optional. Key to check for nonce in `$_REQUEST` (since 2.5).
1074 *                              Default '_wpnonce'.
1075 * @return false|int False if the nonce is invalid, 1 if the nonce is valid and generated between
1076 *                   0-12 hours ago, 2 if the nonce is valid and generated between 12-24 hours ago.
1077 */
1078function check_admin_referer( $action = -1, $query_arg = '_wpnonce' ) {
1079	if ( -1 == $action )
1080		_doing_it_wrong( __FUNCTION__, __( 'You should specify a nonce action to be verified by using the first parameter.' ), '3.2.0' );
1081
1082	$adminurl = strtolower(admin_url());
1083	$referer = strtolower(wp_get_referer());
1084	$result = isset($_REQUEST[$query_arg]) ? wp_verify_nonce($_REQUEST[$query_arg], $action) : false;
1085
1086	/**
1087	 * Fires once the admin request has been validated or not.
1088	 *
1089	 * @since 1.5.1
1090	 *
1091	 * @param string    $action The nonce action.
1092	 * @param false|int $result False if the nonce is invalid, 1 if the nonce is valid and generated between
1093	 *                          0-12 hours ago, 2 if the nonce is valid and generated between 12-24 hours ago.
1094	 */
1095	do_action( 'check_admin_referer', $action, $result );
1096
1097	if ( ! $result && ! ( -1 == $action && strpos( $referer, $adminurl ) === 0 ) ) {
1098		wp_nonce_ays( $action );
1099		die();
1100	}
1101
1102	return $result;
1103}
1104endif;
1105
1106if ( !function_exists('check_ajax_referer') ) :
1107/**
1108 * Verifies the Ajax request to prevent processing requests external of the blog.
1109 *
1110 * @since 2.0.3
1111 *
1112 * @param int|string   $action    Action nonce.
1113 * @param false|string $query_arg Optional. Key to check for the nonce in `$_REQUEST` (since 2.5). If false,
1114 *                                `$_REQUEST` values will be evaluated for '_ajax_nonce', and '_wpnonce'
1115 *                                (in that order). Default false.
1116 * @param bool         $die       Optional. Whether to die early when the nonce cannot be verified.
1117 *                                Default true.
1118 * @return false|int False if the nonce is invalid, 1 if the nonce is valid and generated between
1119 *                   0-12 hours ago, 2 if the nonce is valid and generated between 12-24 hours ago.
1120 */
1121function check_ajax_referer( $action = -1, $query_arg = false, $die = true ) {
1122	if ( -1 == $action ) {
1123		_doing_it_wrong( __FUNCTION__, __( 'You should specify a nonce action to be verified by using the first parameter.' ), '4.7' );
1124	}
1125
1126	$nonce = '';
1127
1128	if ( $query_arg && isset( $_REQUEST[ $query_arg ] ) )
1129		$nonce = $_REQUEST[ $query_arg ];
1130	elseif ( isset( $_REQUEST['_ajax_nonce'] ) )
1131		$nonce = $_REQUEST['_ajax_nonce'];
1132	elseif ( isset( $_REQUEST['_wpnonce'] ) )
1133		$nonce = $_REQUEST['_wpnonce'];
1134
1135	$result = wp_verify_nonce( $nonce, $action );
1136
1137	/**
1138	 * Fires once the Ajax request has been validated or not.
1139	 *
1140	 * @since 2.1.0
1141	 *
1142	 * @param string    $action The Ajax nonce action.
1143	 * @param false|int $result False if the nonce is invalid, 1 if the nonce is valid and generated between
1144	 *                          0-12 hours ago, 2 if the nonce is valid and generated between 12-24 hours ago.
1145	 */
1146	do_action( 'check_ajax_referer', $action, $result );
1147
1148	if ( $die && false === $result ) {
1149		if ( wp_doing_ajax() ) {
1150			wp_die( -1, 403 );
1151		} else {
1152			die( '-1' );
1153		}
1154	}
1155
1156	return $result;
1157}
1158endif;
1159
1160if ( !function_exists('wp_redirect') ) :
1161/**
1162 * Redirects to another page.
1163 *
1164 * Note: wp_redirect() does not exit automatically, and should almost always be
1165 * followed by a call to `exit;`:
1166 *
1167 *     wp_redirect( $url );
1168 *     exit;
1169 *
1170 * Exiting can also be selectively manipulated by using wp_redirect() as a conditional
1171 * in conjunction with the {@see 'wp_redirect'} and {@see 'wp_redirect_location'} hooks:
1172 *
1173 *     if ( wp_redirect( $url ) ) {
1174 *         exit;
1175 *     }
1176 *
1177 * @since 1.5.1
1178 *
1179 * @global bool $is_IIS
1180 *
1181 * @param string $location The path to redirect to.
1182 * @param int    $status   Status code to use.
1183 * @return bool False if $location is not provided, true otherwise.
1184 */
1185function wp_redirect($location, $status = 302) {
1186	global $is_IIS;
1187
1188	/**
1189	 * Filters the redirect location.
1190	 *
1191	 * @since 2.1.0
1192	 *
1193	 * @param string $location The path to redirect to.
1194	 * @param int    $status   Status code to use.
1195	 */
1196	$location = apply_filters( 'wp_redirect', $location, $status );
1197
1198	/**
1199	 * Filters the redirect status code.
1200	 *
1201	 * @since 2.3.0
1202	 *
1203	 * @param int    $status   Status code to use.
1204	 * @param string $location The path to redirect to.
1205	 */
1206	$status = apply_filters( 'wp_redirect_status', $status, $location );
1207
1208	if ( ! $location )
1209		return false;
1210
1211	$location = wp_sanitize_redirect($location);
1212
1213	if ( !$is_IIS && PHP_SAPI != 'cgi-fcgi' )
1214		status_header($status); // This causes problems on IIS and some FastCGI setups
1215	
1216	header("Location: $location", true, $status);
1217
1218	return true;
1219}
1220endif;
1221
1222if ( !function_exists('wp_sanitize_redirect') ) :
1223/**
1224 * Sanitizes a URL for use in a redirect.
1225 *
1226 * @since 2.3.0
1227 *
1228 * @param string $location The path to redirect to.
1229 * @return string Redirect-sanitized URL.
1230 **/
1231function wp_sanitize_redirect($location) {
1232	$regex = '/
1233		(
1234			(?: [\xC2-\xDF][\x80-\xBF]        # double-byte sequences   110xxxxx 10xxxxxx
1235			|   \xE0[\xA0-\xBF][\x80-\xBF]    # triple-byte sequences   1110xxxx 10xxxxxx * 2
1236			|   [\xE1-\xEC][\x80-\xBF]{2}
1237			|   \xED[\x80-\x9F][\x80-\xBF]
1238			|   [\xEE-\xEF][\x80-\xBF]{2}
1239			|   \xF0[\x90-\xBF][\x80-\xBF]{2} # four-byte sequences   11110xxx 10xxxxxx * 3
1240			|   [\xF1-\xF3][\x80-\xBF]{3}
1241			|   \xF4[\x80-\x8F][\x80-\xBF]{2}
1242		){1,40}                              # ...one or more times
1243		)/x';
1244	$location = preg_replace_callback( $regex, '_wp_sanitize_utf8_in_redirect', $location );
1245	$location = preg_replace('|[^a-z0-9-~+_.?#=&;,/:%!*\[\]()@]|i', '', $location);
1246	$location = wp_kses_no_null($location);
1247
1248	// remove %0d and %0a from location
1249	$strip = array('%0d', '%0a', '%0D', '%0A');
1250	return _deep_replace( $strip, $location );
1251}
1252
1253/**
1254 * URL encode UTF-8 characters in a URL.
1255 *
1256 * @ignore
1257 * @since 4.2.0
1258 * @access private
1259 *
1260 * @see wp_sanitize_redirect()
1261 *
1262 * @param array $matches RegEx matches against the redirect location.
1263 * @return string URL-encoded version of the first RegEx match.
1264 */
1265function _wp_sanitize_utf8_in_redirect( $matches ) {
1266	return urlencode( $matches[0] );
1267}
1268endif;
1269
1270if ( !function_exists('wp_safe_redirect') ) :
1271/**
1272 * Performs a safe (local) redirect, using wp_redirect().
1273 *
1274 * Checks whether the $location is using an allowed host, if it has an absolute
1275 * path. A plugin can therefore set or remove allowed host(s) to or from the
1276 * list.
1277 *
1278 * If the host is not allowed, then the redirect defaults to wp-admin on the siteurl
1279 * instead. This prevents malicious redirects which redirect to another host,
1280 * but only used in a few places.
1281 *
1282 * @since 2.3.0
1283 *
1284 * @param string $location The path to redirect to.
1285 * @param int    $status   Status code to use.
1286 */
1287function wp_safe_redirect($location, $status = 302) {
1288
1289	// Need to look at the URL the way it will end up in wp_redirect()
1290	$location = wp_sanitize_redirect($location);
1291
1292	/**
1293	 * Filters the redirect fallback URL for when the provided redirect is not safe (local).
1294	 *
1295	 * @since 4.3.0
1296	 *
1297	 * @param string $fallback_url The fallback URL to use by default.
1298	 * @param int    $status       The redirect status.
1299	 */
1300	$location = wp_validate_redirect( $location, apply_filters( 'wp_safe_redirect_fallback', admin_url(), $status ) );
1301
1302	wp_redirect($location, $status);
1303}
1304endif;
1305
1306if ( !function_exists('wp_validate_redirect') ) :
1307/**
1308 * Validates a URL for use in a redirect.
1309 *
1310 * Checks whether the $location is using an allowed host, if it has an absolute
1311 * path. A plugin can therefore set or remove allowed host(s) to or from the
1312 * list.
1313 *
1314 * If the host is not allowed, then the redirect is to $default supplied
1315 *
1316 * @since 2.8.1
1317 *
1318 * @param string $location The redirect to validate
1319 * @param string $default  The value to return if $location is not allowed
1320 * @return string redirect-sanitized URL
1321 **/
1322function wp_validate_redirect($location, $default = '') {
1323	$location = trim( $location, " \t\n\r\0\x08\x0B" );
1324	// browsers will assume 'http' is your protocol, and will obey a redirect to a URL starting with '//'
1325	if ( substr($location, 0, 2) == '//' )
1326		$location = 'http:' . $location;
1327
1328	// In php 5 parse_url may fail if the URL query part contains http://, bug #38143
1329	$test = ( $cut = strpos($location, '?') ) ? substr( $location, 0, $cut ) : $location;
1330
1331	// @-operator is used to prevent possible warnings in PHP < 5.3.3.
1332	$lp = @parse_url($test);
1333
1334	// Give up if malformed URL
1335	if ( false === $lp )
1336		return $default;
1337
1338	// Allow only http and https schemes. No data:, etc.
1339	if ( isset($lp['scheme']) && !('http' == $lp['scheme'] || 'https' == $lp['scheme']) )
1340		return $default;
1341
1342	// 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.
1343	if ( ! isset( $lp['host'] ) && ( isset( $lp['scheme'] ) || isset( $lp['user'] ) || isset( $lp['pass'] ) || isset( $lp['port'] ) ) ) {
1344		return $default;
1345	}
1346
1347	// Reject malformed components parse_url() can return on odd inputs.
1348	foreach ( array( 'user', 'pass', 'host' ) as $component ) {
1349		if ( isset( $lp[ $component ] ) && strpbrk( $lp[ $component ], ':/?#@' ) ) {
1350			return $default;
1351		}
1352	}
1353
1354	$wpp = parse_url(home_url());
1355
1356	/**
1357	 * Filters the whitelist of hosts to redirect to.
1358	 *
1359	 * @since 2.3.0
1360	 *
1361	 * @param array       $hosts An array of allowed hosts.
1362	 * @param bool|string $host  The parsed host; empty if not isset.
1363	 */
1364	$allowed_hosts = (array) apply_filters( 'allowed_redirect_hosts', array($wpp['host']), isset($lp['host']) ? $lp['host'] : '' );
1365
1366	if ( isset($lp['host']) && ( !in_array($lp['host'], $allowed_hosts) && $lp['host'] != strtolower($wpp['host'])) )
1367		$location = $default;
1368
1369	return $location;
1370}
1371endif;
1372
1373if ( ! function_exists('wp_notify_postauthor') ) :
1374/**
1375 * Notify an author (and/or others) of a comment/trackback/pingback on a post.
1376 *
1377 * @since 1.0.0
1378 *
1379 * @param int|WP_Comment  $comment_id Comment ID or WP_Comment object.
1380 * @param string          $deprecated Not used
1381 * @return bool True on completion. False if no email addresses were specified.
1382 */
1383function wp_notify_postauthor( $comment_id, $deprecated = null ) {
1384	if ( null !== $deprecated ) {
1385		_deprecated_argument( __FUNCTION__, '3.8.0' );
1386	}
1387
1388	$comment = get_comment( $comment_id );
1389	if ( empty( $comment ) || empty( $comment->comment_post_ID ) )
1390		return false;
1391
1392	$post    = get_post( $comment->comment_post_ID );
1393	$author  = get_userdata( $post->post_author );
1394
1395	// Who to notify? By default, just the post author, but others can be added.
1396	$emails = array();
1397	if ( $author ) {
1398		$emails[] = $author->user_email;
1399	}
1400
1401	/**
1402	 * Filters the list of email addresses to receive a comment notification.
1403	 *
1404	 * By default, only post authors are notified of comments. This filter allows
1405	 * others to be added.
1406	 *
1407	 * @since 3.7.0
1408	 *
1409	 * @param array $emails     An array of email addresses to receive a comment notification.
1410	 * @param int   $comment_id The comment ID.
1411	 */
1412	$emails = apply_filters( 'comment_notification_recipients', $emails, $comment->comment_ID );
1413	$emails = array_filter( $emails );
1414
1415	// If there are no addresses to send the comment to, bail.
1416	if ( ! count( $emails ) ) {
1417		return false;
1418	}
1419
1420	// Facilitate unsetting below without knowing the keys.
1421	$emails = array_flip( $emails );
1422
1423	/**
1424	 * Filters whether to notify comment authors of their comments on their own posts.
1425	 *
1426	 * By default, comment authors aren't notified of their comments on their own
1427	 * posts. This filter allows you to override that.
1428	 *
1429	 * @since 3.8.0
1430	 *
1431	 * @param bool $notify     Whether to notify the post author of their own comment.
1432	 *                         Default false.
1433	 * @param int  $comment_id The comment ID.
1434	 */
1435	$notify_author = apply_filters( 'comment_notification_notify_author', false, $comment->comment_ID );
1436
1437	// The comment was left by the author
1438	if ( $author && ! $notify_author && $comment->user_id == $post->post_author ) {
1439		unset( $emails[ $author->user_email ] );
1440	}
1441
1442	// The author moderated a comment on their own post
1443	if ( $author && ! $notify_author && $post->post_author == get_current_user_id() ) {
1444		unset( $emails[ $author->user_email ] );
1445	}
1446
1447	// The post author is no longer a member of the blog
1448	if ( $author && ! $notify_author && ! user_can( $post->post_author, 'read_post', $post->ID ) ) {
1449		unset( $emails[ $author->user_email ] );
1450	}
1451
1452	// If there's no email to send the comment to, bail, otherwise flip array back around for use below
1453	if ( ! count( $emails ) ) {
1454		return false;
1455	} else {
1456		$emails = array_flip( $emails );
1457	}
1458
1459	$switched_locale = switch_to_locale( get_locale() );
1460
1461	$comment_author_domain = @gethostbyaddr($comment->comment_author_IP);
1462
1463	// The blogname option is escaped with esc_html on the way into the database in sanitize_option
1464	// we want to reverse this for the plain text arena of emails.
1465	$blogname = wp_specialchars_decode(get_option('blogname'), ENT_QUOTES);
1466	$comment_content = wp_specialchars_decode( $comment->comment_content );
1467
1468	switch ( $comment->comment_type ) {
1469		case 'trackback':
1470			/* translators: 1: Post title */
1471			$notify_message  = sprintf( __( 'New trackback on your post "%s"' ), $post->post_title ) . "\r\n";
1472			/* translators: 1: Trackback/pingback website name, 2: website IP address, 3: website hostname */
1473			$notify_message .= sprintf( __('Website: %1$s (IP address: %2$s, %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
1474			$notify_message .= sprintf( __( 'URL: %s' ), $comment->comment_author_url ) . "\r\n";
1475			$notify_message .= sprintf( __( 'Comment: %s' ), "\r\n" . $comment_content ) . "\r\n\r\n";
1476			$notify_message .= __( 'You can see all trackbacks on this post here:' ) . "\r\n";
1477			/* translators: 1: blog name, 2: post title */
1478			$subject = sprintf( __('[%1$s] Trackback: "%2$s"'), $blogname, $post->post_title );
1479			break;
1480		case 'pingback':
1481			/* translators: 1: Post title */
1482			$notify_message  = sprintf( __( 'New pingback on your post "%s"' ), $post->post_title ) . "\r\n";
1483			/* translators: 1: Trackback/pingback website name, 2: website IP address, 3: website hostname */
1484			$notify_message .= sprintf( __('Website: %1$s (IP address: %2$s, %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
1485			$notify_message .= sprintf( __( 'URL: %s' ), $comment->comment_author_url ) . "\r\n";
1486			$notify_message .= sprintf( __( 'Comment: %s' ), "\r\n" . $comment_content ) . "\r\n\r\n";
1487			$notify_message .= __( 'You can see all pingbacks on this post here:' ) . "\r\n";
1488			/* translators: 1: blog name, 2: post title */
1489			$subject = sprintf( __('[%1$s] Pingback: "%2$s"'), $blogname, $post->post_title );
1490			break;
1491		default: // Comments
1492			$notify_message  = sprintf( __( 'New comment on your post "%s"' ), $post->post_title ) . "\r\n";
1493			/* translators: 1: comment author, 2: comment author's IP address, 3: comment author's hostname */
1494			$notify_message .= sprintf( __( 'Author: %1$s (IP address: %2$s, %3$s)' ), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
1495			$notify_message .= sprintf( __( 'Email: %s' ), $comment->comment_author_email ) . "\r\n";
1496			$notify_message .= sprintf( __( 'URL: %s' ), $comment->comment_author_url ) . "\r\n";
1497			$notify_message .= sprintf( __('Comment: %s' ), "\r\n" . $comment_content ) . "\r\n\r\n";
1498			$notify_message .= __( 'You can see all comments on this post here:' ) . "\r\n";
1499			/* translators: 1: blog name, 2: post title */
1500			$subject = sprintf( __('[%1$s] Comment: "%2$s"'), $blogname, $post->post_title );
1501			break;
1502	}
1503	$notify_message .= get_permalink($comment->comment_post_ID) . "#comments\r\n\r\n";
1504	$notify_message .= sprintf( __('Permalink: %s'), get_comment_link( $comment ) ) . "\r\n";
1505
1506	if ( user_can( $post->post_author, 'edit_comment', $comment->comment_ID ) ) {
1507		if ( EMPTY_TRASH_DAYS ) {
1508			$notify_message .= sprintf( __( 'Trash it: %s' ), admin_url( "comment.php?action=trash&c={$comment->comment_ID}#wpbody-content" ) ) . "\r\n";
1509		} else {
1510			$notify_message .= sprintf( __( 'Delete it: %s' ), admin_url( "comment.php?action=delete&c={$comment->comment_ID}#wpbody-content" ) ) . "\r\n";
1511		}
1512		$notify_message .= sprintf( __( 'Spam it: %s' ), admin_url( "comment.php?action=spam&c={$comment->comment_ID}#wpbody-content" ) ) . "\r\n";
1513	}
1514
1515	$wp_email = 'wordpress@' . preg_replace('#^www\.#', '', strtolower($_SERVER['SERVER_NAME']));
1516
1517	if ( '' == $comment->comment_author ) {
1518		$from = "From: \"$blogname\" <$wp_email>";
1519		if ( '' != $comment->comment_author_email )
1520			$reply_to = "Reply-To: $comment->comment_author_email";
1521	} else {
1522		$from = "From: \"$comment->comment_author\" <$wp_email>";
1523		if ( '' != $comment->comment_author_email )
1524			$reply_to = "Reply-To: \"$comment->comment_author_email\" <$comment->comment_author_email>";
1525	}
1526
1527	$message_headers = "$from\n"
1528		. "Content-Type: text/plain; charset=\"" . get_option('blog_charset') . "\"\n";
1529
1530	if ( isset($reply_to) )
1531		$message_headers .= $reply_to . "\n";
1532
1533	/**
1534	 * Filters the comment notification email text.
1535	 *
1536	 * @since 1.5.2
1537	 *
1538	 * @param string $notify_message The comment notification email text.
1539	 * @param int    $comment_id     Comment ID.
1540	 */
1541	$notify_message = apply_filters( 'comment_notification_text', $notify_message, $comment->comment_ID );
1542
1543	/**
1544	 * Filters the comment notification email subject.
1545	 *
1546	 * @since 1.5.2
1547	 *
1548	 * @param string $subject    The comment notification email subject.
1549	 * @param int    $comment_id Comment ID.
1550	 */
1551	$subject = apply_filters( 'comment_notification_subject', $subject, $comment->comment_ID );
1552
1553	/**
1554	 * Filters the comment notification email headers.
1555	 *
1556	 * @since 1.5.2
1557	 *
1558	 * @param string $message_headers Headers for the comment notification email.
1559	 * @param int    $comment_id      Comment ID.
1560	 */
1561	$message_headers = apply_filters( 'comment_notification_headers', $message_headers, $comment->comment_ID );
1562
1563	foreach ( $emails as $email ) {
1564		@wp_mail( $email, wp_specialchars_decode( $subject ), $notify_message, $message_headers );
1565	}
1566
1567	if ( $switched_locale ) {
1568		restore_previous_locale();
1569	}
1570
1571	return true;
1572}
1573endif;
1574
1575if ( !function_exists('wp_notify_moderator') ) :
1576/**
1577 * Notifies the moderator of the site about a new comment that is awaiting approval.
1578 *
1579 * @since 1.0.0
1580 *
1581 * @global wpdb $wpdb WordPress database abstraction object.
1582 *
1583 * Uses the {@see 'notify_moderator'} filter to determine whether the site moderator
1584 * should be notified, overriding the site setting.
1585 *
1586 * @param int $comment_id Comment ID.
1587 * @return true Always returns true.
1588 */
1589function wp_notify_moderator($comment_id) {
1590	global $wpdb;
1591
1592	$maybe_notify = get_option( 'moderation_notify' );
1593
1594	/**
1595	 * Filters whether to send the site moderator email notifications, overriding the site setting.
1596	 *
1597	 * @since 4.4.0
1598	 *
1599	 * @param bool $maybe_notify Whether to notify blog moderator.
1600	 * @param int  $comment_ID   The id of the comment for the notification.
1601	 */
1602	$maybe_notify = apply_filters( 'notify_moderator', $maybe_notify, $comment_id );
1603
1604	if ( ! $maybe_notify ) {
1605		return true;
1606	}
1607
1608	$comment = get_comment($comment_id);
1609	$post = get_post($comment->comment_post_ID);
1610	$user = get_userdata( $post->post_author );
1611	// Send to the administration and to the post author if the author can modify the comment.
1612	$emails = array( get_option( 'admin_email' ) );
1613	if ( $user && user_can( $user->ID, 'edit_comment', $comment_id ) && ! empty( $user->user_email ) ) {
1614		if ( 0 !== strcasecmp( $user->user_email, get_option( 'admin_email' ) ) )
1615			$emails[] = $user->user_email;
1616	}
1617
1618	$switched_locale = switch_to_locale( get_locale() );
1619
1620	$comment_author_domain = @gethostbyaddr($comment->comment_author_IP);
1621	$comments_waiting = $wpdb->get_var("SELECT count(comment_ID) FROM $wpdb->comments WHERE comment_approved = '0'");
1622
1623	// The blogname option is escaped with esc_html on the way into the database in sanitize_option
1624	// we want to reverse this for the plain text arena of emails.
1625	$blogname = wp_specialchars_decode(get_option('blogname'), ENT_QUOTES);
1626	$comment_content = wp_specialchars_decode( $comment->comment_content );
1627
1628	switch ( $comment->comment_type ) {
1629		case 'trackback':
1630			/* translators: 1: Post title */
1631			$notify_message  = sprintf( __('A new trackback on the post "%s" is waiting for your approval'), $post->post_title ) . "\r\n";
1632			$notify_message .= get_permalink($comment->comment_post_ID) . "\r\n\r\n";
1633			/* translators: 1: Trackback/pingback website name, 2: website IP address, 3: website hostname */
1634			$notify_message .= sprintf( __( 'Website: %1$s (IP address: %2$s, %3$s)' ), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
1635			/* translators: 1: Trackback/pingback/comment author URL */
1636			$notify_message .= sprintf( __( 'URL: %s' ), $comment->comment_author_url ) . "\r\n";
1637			$notify_message .= __('Trackback excerpt: ') . "\r\n" . $comment_content . "\r\n\r\n";
1638			break;
1639		case 'pingback':
1640			/* translators: 1: Post title */
1641			$notify_message  = sprintf( __('A new pingback on the post "%s" is waiting for your approval'), $post->post_title ) . "\r\n";
1642			$notify_message .= get_permalink($comment->comment_post_ID) . "\r\n\r\n";
1643			/* translators: 1: Trackback/pingback website name, 2: website IP address, 3: website hostname */
1644			$notify_message .= sprintf( __( 'Website: %1$s (IP address: %2$s, %3$s)' ), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
1645			/* translators: 1: Trackback/pingback/comment author URL */
1646			$notify_message .= sprintf( __( 'URL: %s' ), $comment->comment_author_url ) . "\r\n";
1647			$notify_message .= __('Pingback excerpt: ') . "\r\n" . $comment_content . "\r\n\r\n";
1648			break;
1649		default: // Comments
1650			/* translators: 1: Post title */
1651			$notify_message  = sprintf( __('A new comment on the post "%s" is waiting for your approval'), $post->post_title ) . "\r\n";
1652			$notify_message .= get_permalink($comment->comment_post_ID) . "\r\n\r\n";
1653			/* translators: 1: Comment author name, 2: comment author's IP address, 3: comment author's hostname */
1654			$notify_message .= sprintf( __( 'Author: %1$s (IP address: %2$s, %3$s)' ), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
1655			/* translators: 1: Comment author URL */
1656			$notify_message .= sprintf( __( 'Email: %s' ), $comment->comment_author_email ) . "\r\n";
1657			/* translators: 1: Trackback/pingback/comment author URL */
1658			$notify_message .= sprintf( __( 'URL: %s' ), $comment->comment_author_url ) . "\r\n";
1659			/* translators: 1: Comment text */
1660			$notify_message .= sprintf( __( 'Comment: %s' ), "\r\n" . $comment_content ) . "\r\n\r\n";
1661			break;
1662	}
1663
1664	/* translators: Comment moderation. 1: Comment action URL */
1665	$notify_message .= sprintf( __( 'Approve it: %s' ), admin_url( "comment.php?action=approve&c={$comment_id}#wpbody-content" ) ) . "\r\n";
1666
1667	if ( EMPTY_TRASH_DAYS ) {
1668		/* translators: Comment moderation. 1: Comment action URL */
1669		$notify_message .= sprintf( __( 'Trash it: %s' ), admin_url( "comment.php?action=trash&c={$comment_id}#wpbody-content" ) ) . "\r\n";
1670	} else {
1671		/* translators: Comment moderation. 1: Comment action URL */
1672		$notify_message .= sprintf( __( 'Delete it: %s' ), admin_url( "comment.php?action=delete&c={$comment_id}#wpbody-content" ) ) . "\r\n";
1673	}
1674
1675	/* translators: Comment moderation. 1: Comment action URL */
1676	$notify_message .= sprintf( __( 'Spam it: %s' ), admin_url( "comment.php?action=spam&c={$comment_id}#wpbody-content" ) ) . "\r\n";
1677
1678	/* translators: Comment moderation. 1: Number of comments awaiting approval */
1679	$notify_message .= sprintf( _n('Currently %s comment is waiting for approval. Please visit the moderation panel:',
1680 		'Currently %s comments are waiting for approval. Please visit the moderation panel:', $comments_waiting), number_format_i18n($comments_waiting) ) . "\r\n";
1681	$notify_message .= admin_url( "edit-comments.php?comment_status=moderated#wpbody-content" ) . "\r\n";
1682
1683	/* translators: Comment moderation notification email subject. 1: Site name, 2: Post title */
1684	$subject = sprintf( __('[%1$s] Please moderate: "%2$s"'), $blogname, $post->post_title );
1685	$message_headers = '';
1686
1687	/**
1688	 * Filters the list of recipients for comment moderation emails.
1689	 *
1690	 * @since 3.7.0
1691	 *
1692	 * @param array $emails     List of email addresses to notify for comment moderation.
1693	 * @param int   $comment_id Comment ID.
1694	 */
1695	$emails = apply_filters( 'comment_moderation_recipients', $emails, $comment_id );
1696
1697	/**
1698	 * Filters the comment moderation email text.
1699	 *
1700	 * @since 1.5.2
1701	 *
1702	 * @param string $notify_message Text of the comment moderation email.
1703	 * @param int    $comment_id     Comment ID.
1704	 */
1705	$notify_message = apply_filters( 'comment_moderation_text', $notify_message, $comment_id );
1706
1707	/**
1708	 * Filters the comment moderation email subject.
1709	 *
1710	 * @since 1.5.2
1711	 *
1712	 * @param string $subject    Subject of the comment moderation email.
1713	 * @param int    $comment_id Comment ID.
1714	 */
1715	$subject = apply_filters( 'comment_moderation_subject', $subject, $comment_id );
1716
1717	/**
1718	 * Filters the comment moderation email headers.
1719	 *
1720	 * @since 2.8.0
1721	 *
1722	 * @param string $message_headers Headers for the comment moderation email.
1723	 * @param int    $comment_id      Comment ID.
1724	 */
1725	$message_headers = apply_filters( 'comment_moderation_headers', $message_headers, $comment_id );
1726
1727	foreach ( $emails as $email ) {
1728		@wp_mail( $email, wp_specialchars_decode( $subject ), $notify_message, $message_headers );
1729	}
1730
1731	if ( $switched_locale ) {
1732		restore_previous_locale();
1733	}
1734
1735	return true;
1736}
1737endif;
1738
1739if ( !function_exists('wp_password_change_notification') ) :
1740/**
1741 * Notify the blog admin of a user changing password, normally via email.
1742 *
1743 * @since 2.7.0
1744 *
1745 * @param WP_User $user User object.
1746 */
1747function wp_password_change_notification( $user ) {
1748	// send a copy of password change notification to the admin
1749	// but check to see if it's the admin whose password we're changing, and skip this
1750	if ( 0 !== strcasecmp( $user->user_email, get_option( 'admin_email' ) ) ) {
1751		/* translators: %s: user name */
1752		$message = sprintf( __( 'Password changed for user: %s' ), $user->user_login ) . "\r\n";
1753		// The blogname option is escaped with esc_html on the way into the database in sanitize_option
1754		// we want to reverse this for the plain text arena of emails.
1755		$blogname = wp_specialchars_decode(get_option('blogname'), ENT_QUOTES);
1756
1757		$wp_password_change_notification_email = array(
1758			'to'      => get_option( 'admin_email' ),
1759			/* translators: Password change notification email subject. %s: Site title */
1760			'subject' => __( '[%s] Password Changed' ),
1761			'message' => $message,
1762			'headers' => '',
1763		);
1764
1765		/**
1766		 * Filters the contents of the password change notification email sent to the site admin.
1767		 *
1768		 * @since 4.9.0
1769		 *
1770		 * @param array   $wp_password_change_notification_email {
1771		 *     Used to build wp_mail().
1772		 *
1773		 *     @type string $to      The intended recipient - site admin email address.
1774		 *     @type string $subject The subject of the email.
1775		 *     @type string $message The body of the email.
1776		 *     @type string $headers The headers of the email.
1777		 * }
1778		 * @param WP_User $user     User object for user whose password was changed.
1779		 * @param string  $blogname The site title.
1780		 */
1781		$wp_password_change_notification_email = apply_filters( 'wp_password_change_notification_email', $wp_password_change_notification_email, $user, $blogname );
1782
1783		wp_mail(
1784			$wp_password_change_notification_email['to'],
1785			wp_specialchars_decode( sprintf( $wp_password_change_notification_email['subject'], $blogname ) ),
1786			$wp_password_change_notification_email['message'],
1787			$wp_password_change_notification_email['headers']
1788		);
1789	}
1790}
1791endif;
1792
1793if ( !function_exists('wp_new_user_notification') ) :
1794/**
1795 * Email login credentials to a newly-registered user.
1796 *
1797 * A new user registration notification is also sent to admin email.
1798 *
1799 * @since 2.0.0
1800 * @since 4.3.0 The `$plaintext_pass` parameter was changed to `$notify`.
1801 * @since 4.3.1 The `$plaintext_pass` parameter was deprecated. `$notify` added as a third parameter.
1802 * @since 4.6.0 The `$notify` parameter accepts 'user' for sending notification only to the user created.
1803 *
1804 * @global wpdb         $wpdb      WordPress database object for queries.
1805 * @global PasswordHash $wp_hasher Portable PHP password hashing framework instance.
1806 *
1807 * @param int    $user_id    User ID.
1808 * @param null   $deprecated Not used (argument deprecated).
1809 * @param string $notify     Optional. Type of notification that should happen. Accepts 'admin' or an empty
1810 *                           string (admin only), 'user', or 'both' (admin and user). Default empty.
1811 */
1812function wp_new_user_notification( $user_id, $deprecated = null, $notify = '' ) {
1813	if ( $deprecated !== null ) {
1814		_deprecated_argument( __FUNCTION__, '4.3.1' );
1815	}
1816
1817	global $wpdb, $wp_hasher;
1818	$user = get_userdata( $user_id );
1819
1820	// The blogname option is escaped with esc_html on the way into the database in sanitize_option
1821	// we want to reverse this for the plain text arena of emails.
1822	$blogname = wp_specialchars_decode(get_option('blogname'), ENT_QUOTES);
1823
1824	if ( 'user' !== $notify ) {
1825		$switched_locale = switch_to_locale( get_locale() );
1826
1827		/* translators: %s: site title */
1828		$message  = sprintf( __( 'New user registration on your site %s:' ), $blogname ) . "\r\n\r\n";
1829		/* translators: %s: user login */
1830		$message .= sprintf( __( 'Username: %s' ), $user->user_login ) . "\r\n\r\n";
1831		/* translators: %s: user email address */
1832		$message .= sprintf( __( 'Email: %s' ), $user->user_email ) . "\r\n";
1833
1834		$wp_new_user_notification_email_admin = array(
1835			'to'      => get_option( 'admin_email' ),
1836			/* translators: Password change notification email subject. %s: Site title */
1837			'subject' => __( '[%s] New User Registration' ),
1838			'message' => $message,
1839			'headers' => '',
1840		);
1841
1842		/**
1843		 * Filters the contents of the new user notification email sent to the site admin.
1844		 *
1845		 * @since 4.9.0
1846		 *
1847		 * @param array   $wp_new_user_notification_email {
1848		 *     Used to build wp_mail().
1849		 *
1850		 *     @type string $to      The intended recipient - site admin email address.
1851		 *     @type string $subject The subject of the email.
1852		 *     @type string $message The body of the email.
1853		 *     @type string $headers The headers of the email.
1854		 * }
1855		 * @param WP_User $user     User object for new user.
1856		 * @param string  $blogname The site title.
1857		 */
1858		$wp_new_user_notification_email_admin = apply_filters( 'wp_new_user_notification_email_admin', $wp_new_user_notification_email_admin, $user, $blogname );
1859
1860		@wp_mail(
1861			$wp_new_user_notification_email_admin['to'],
1862			wp_specialchars_decode( sprintf( $wp_new_user_notification_email_admin['subject'], $blogname ) ),
1863			$wp_new_user_notification_email_admin['message'],
1864			$wp_new_user_notification_email_admin['headers']
1865		);
1866
1867		if ( $switched_locale ) {
1868			restore_previous_locale();
1869		}
1870	}
1871
1872	// `$deprecated was pre-4.3 `$plaintext_pass`. An empty `$plaintext_pass` didn't sent a user notification.
1873	if ( 'admin' === $notify || ( empty( $deprecated ) && empty( $notify ) ) ) {
1874		return;
1875	}
1876
1877	// Generate something random for a password reset key.
1878	$key = wp_generate_password( 20, false );
1879
1880	/** This action is documented in wp-login.php */
1881	do_action( 'retrieve_password_key', $user->user_login, $key );
1882
1883	// Now insert the key, hashed, into the DB.
1884	if ( empty( $wp_hasher ) ) {
1885		require_once ABSPATH . WPINC . '/class-phpass.php';
1886		$wp_hasher = new PasswordHash( 8, true );
1887	}
1888	$hashed = time() . ':' . $wp_hasher->HashPassword( $key );
1889	$wpdb->update( $wpdb->users, array( 'user_activation_key' => $hashed ), array( 'user_login' => $user->user_login ) );
1890
1891	$switched_locale = switch_to_locale( get_user_locale( $user ) );
1892
1893	/* translators: %s: user login */
1894	$message = sprintf(__('Username: %s'), $user->user_login) . "\r\n\r\n";
1895	$message .= __('To set your password, visit the following address:') . "\r\n\r\n";
1896	$message .= '<' . network_site_url("wp-login.php?action=rp&key=$key&login=" . rawurlencode($user->user_login), 'login') . ">\r\n\r\n";
1897
1898	$message .= wp_login_url() . "\r\n";
1899
1900	$wp_new_user_notification_email = array(
1901		'to'      => $user->user_email,
1902		/* translators: Password change notification email subject. %s: Site title */
1903		'subject' => __( '[%s] Your username and password info' ),
1904		'message' => $message,
1905		'headers' => '',
1906	);
1907
1908	/**
1909	 * Filters the contents of the new user notification email sent to the new user.
1910	 *
1911	 * @since 4.9.0
1912	 *
1913	 * @param array   $wp_new_user_notification_email {
1914	 *     Used to build wp_mail().
1915	 *
1916	 *     @type string $to      The intended recipient - New user email address.
1917	 *     @type string $subject The subject of the email.
1918	 *     @type string $message The body of the email.
1919	 *     @type string $headers The headers of the email.
1920	 * }
1921	 * @param WP_User $user     User object for new user.
1922	 * @param string  $blogname The site title.
1923	 */
1924	$wp_new_user_notification_email = apply_filters( 'wp_new_user_notification_email', $wp_new_user_notification_email, $user, $blogname );
1925
1926	wp_mail(
1927		$wp_new_user_notification_email['to'],
1928		wp_specialchars_decode( sprintf( $wp_new_user_notification_email['subject'], $blogname ) ),
1929		$wp_new_user_notification_email['message'],
1930		$wp_new_user_notification_email['headers']
1931	);
1932
1933	if ( $switched_locale ) {
1934		restore_previous_locale();
1935	}
1936}
1937endif;
1938
1939if ( !function_exists('wp_nonce_tick') ) :
1940/**
1941 * Get the time-dependent variable for nonce creation.
1942 *
1943 * A nonce has a lifespan of two ticks. Nonces in their second tick may be
1944 * updated, e.g. by autosave.
1945 *
1946 * @since 2.5.0
1947 *
1948 * @return float Float value rounded up to the next highest integer.
1949 */
1950function wp_nonce_tick() {
1951	/**
1952	 * Filters the lifespan of nonces in seconds.
1953	 *
1954	 * @since 2.5.0
1955	 *
1956	 * @param int $lifespan Lifespan of nonces in seconds. Default 86,400 seconds, or one day.
1957	 */
1958	$nonce_life = apply_filters( 'nonce_life', DAY_IN_SECONDS );
1959
1960	return ceil(time() / ( $nonce_life / 2 ));
1961}
1962endif;
1963
1964if ( !function_exists('wp_verify_nonce') ) :
1965/**
1966 * Verify that correct nonce was used with time limit.
1967 *
1968 * The user is given an amount of time to use the token, so therefore, since the
1969 * UID and $action remain the same, the independent variable is the time.
1970 *
1971 * @since 2.0.3
1972 *
1973 * @param string     $nonce  Nonce that was used in the form to verify
1974 * @param string|int $action Should give context to what is taking place and be the same when nonce was created.
1975 * @return false|int False if the nonce is invalid, 1 if the nonce is valid and generated between
1976 *                   0-12 hours ago, 2 if the nonce is valid and generated between 12-24 hours ago.
1977 */
1978function wp_verify_nonce( $nonce, $action = -1 ) {
1979	$nonce = (string) $nonce;
1980	$user = wp_get_current_user();
1981	$uid = (int) $user->ID;
1982	if ( ! $uid ) {
1983		/**
1984		 * Filters whether the user who generated the nonce is logged out.
1985		 *
1986		 * @since 3.5.0
1987		 *
1988		 * @param int    $uid    ID of the nonce-owning user.
1989		 * @param string $action The nonce action.
1990		 */
1991		$uid = apply_filters( 'nonce_user_logged_out', $uid, $action );
1992	}
1993
1994	if ( empty( $nonce ) ) {
1995		return false;
1996	}
1997
1998	$token = wp_get_session_token();
1999	$i = wp_nonce_tick();
2000
2001	// Nonce generated 0-12 hours ago
2002	$expected = substr( wp_hash( $i . '|' . $action . '|' . $uid . '|' . $token, 'nonce'), -12, 10 );
2003	if ( hash_equals( $expected, $nonce ) ) {
2004		return 1;
2005	}
2006
2007	// Nonce generated 12-24 hours ago
2008	$expected = substr( wp_hash( ( $i - 1 ) . '|' . $action . '|' . $uid . '|' . $token, 'nonce' ), -12, 10 );
2009	if ( hash_equals( $expected, $nonce ) ) {
2010		return 2;
2011	}
2012
2013	/**
2014	 * Fires when nonce verification fails.
2015	 *
2016	 * @since 4.4.0
2017	 *
2018	 * @param string     $nonce  The invalid nonce.
2019	 * @param string|int $action The nonce action.
2020	 * @param WP_User    $user   The current user object.
2021	 * @param string     $token  The user's session token.
2022	 */
2023	do_action( 'wp_verify_nonce_failed', $nonce, $action, $user, $token );
2024
2025	// Invalid nonce
2026	return false;
2027}
2028endif;
2029
2030if ( !function_exists('wp_create_nonce') ) :
2031/**
2032 * Creates a cryptographic token tied to a specific action, user, user session,
2033 * and window of time.
2034 *
2035 * @since 2.0.3
2036 * @since 4.0.0 Session tokens were integrated with nonce creation
2037 *
2038 * @param string|int $action Scalar value to add context to the nonce.
2039 * @return string The token.
2040 */
2041function wp_create_nonce($action = -1) {
2042	$user = wp_get_current_user();
2043	$uid = (int) $user->ID;
2044	if ( ! $uid ) {
2045		/** This filter is documented in wp-includes/pluggable.php */
2046		$uid = apply_filters( 'nonce_user_logged_out', $uid, $action );
2047	}
2048
2049	$token = wp_get_session_token();
2050	$i = wp_nonce_tick();
2051
2052	return substr( wp_hash( $i . '|' . $action . '|' . $uid . '|' . $token, 'nonce' ), -12, 10 );
2053}
2054endif;
2055
2056if ( !function_exists('wp_salt') ) :
2057/**
2058 * Get salt to add to hashes.
2059 *
2060 * Salts are created using secret keys. Secret keys are located in two places:
2061 * in the database and in the wp-config.php file. The secret key in the database
2062 * is randomly generated and will be appended to the secret keys in wp-config.php.
2063 *
2064 * The secret keys in wp-config.php should be updated to strong, random keys to maximize
2065 * security. Below is an example of how the secret key constants are defined.
2066 * Do not paste this example directly into wp-config.php. Instead, have a
2067 * {@link https://api.wordpress.org/secret-key/1.1/salt/ secret key created} just
2068 * for you.
2069 *
2070 *     define('AUTH_KEY',         ' Xakm<o xQy rw4EMsLKM-?!T+,PFF})H4lzcW57AF0U@N@< >M%G4Yt>f`z]MON');
2071 *     define('SECURE_AUTH_KEY',  'LzJ}op]mr|6+![P}Ak:uNdJCJZd>(Hx.-Mh#Tz)pCIU#uGEnfFz|f ;;eU%/U^O~');
2072 *     define('LOGGED_IN_KEY',    '|i|Ux`9<p-h$aFf(qnT:sDO:D1P^wZ$$/Ra@miTJi9G;ddp_<q}6H1)o|a +&JCM');
2073 *     define('NONCE_KEY',        '%:R{[P|,s.KuMltH5}cI;/k<Gx~j!f0I)m_sIyu+&NJZ)-iO>z7X>QYR0Z_XnZ@|');
2074 *     define('AUTH_SALT',        'eZyT)-Naw]F8CwA*VaW#q*|.)g@o}||wf~@C-YSt}(dh_r6EbI#A,y|nU2{B#JBW');
2075 *     define('SECURE_AUTH_SALT', '!=oLUTXh,QW=H `}`L|9/^4-3 STz},T(w}W<I`.JjPi)<Bmf1v,HpGe}T1:Xt7n');
2076 *     define('LOGGED_IN_SALT',   '+XSqHc;@Q*K_b|Z?NC[3H!!EONbh.n<+=uKR:>*c(u`g~EJBf#8u#R{mUEZrozmm');
2077 *     define('NONCE_SALT',       'h`GXHhD>SLWVfg1(1(N{;.V!MoE(SfbA_ksP@&`+AycHcAV$+?@3q+rxV{%^VyKT');
2078 *
2079 * Salting passwords helps against tools which has stored hashed values of
2080 * common dictionary strings. The added values makes it harder to crack.
2081 *
2082 * @since 2.5.0
2083 *
2084 * @link https://api.wordpress.org/secret-key/1.1/salt/ Create secrets for wp-config.php
2085 *
2086 * @staticvar array $cached_salts
2087 * @staticvar array $duplicated_keys
2088 *
2089 * @param string $scheme Authentication scheme (auth, secure_auth, logged_in, nonce)
2090 * @return string Salt value
2091 */
2092function wp_salt( $scheme = 'auth' ) {
2093	static $cached_salts = array();
2094	if ( isset( $cached_salts[ $scheme ] ) ) {
2095		/**
2096		 * Filters the WordPress salt.
2097		 *
2098		 * @since 2.5.0
2099		 *
2100		 * @param string $cached_salt Cached salt for the given scheme.
2101		 * @param string $scheme      Authentication scheme. Values include 'auth',
2102		 *                            'secure_auth', 'logged_in', and 'nonce'.
2103		 */
2104		return apply_filters( 'salt', $cached_salts[ $scheme ], $scheme );
2105	}
2106
2107	static $duplicated_keys;
2108	if ( null === $duplicated_keys ) {
2109		$duplicated_keys = array( 'put your unique phrase here' => true );
2110		foreach ( array( 'AUTH', 'SECURE_AUTH', 'LOGGED_IN', 'NONCE', 'SECRET' ) as $first ) {
2111			foreach ( array( 'KEY', 'SALT' ) as $second ) {
2112				if ( ! defined( "{$first}_{$second}" ) ) {
2113					continue;
2114				}
2115				$value = constant( "{$first}_{$second}" );
2116				$duplicated_keys[ $value ] = isset( $duplicated_keys[ $value ] );
2117			}
2118		}
2119	}
2120
2121	$values = array(
2122		'key' => '',
2123		'salt' => ''
2124	);
2125	if ( defined( 'SECRET_KEY' ) && SECRET_KEY && empty( $duplicated_keys[ SECRET_KEY ] ) ) {
2126		$values['key'] = SECRET_KEY;
2127	}
2128	if ( 'auth' == $scheme && defined( 'SECRET_SALT' ) && SECRET_SALT && empty( $duplicated_keys[ SECRET_SALT ] ) ) {
2129		$values['salt'] = SECRET_SALT;
2130	}
2131
2132	if ( in_array( $scheme, array( 'auth', 'secure_auth', 'logged_in', 'nonce' ) ) ) {
2133		foreach ( array( 'key', 'salt' ) as $type ) {
2134			$const = strtoupper( "{$scheme}_{$type}" );
2135			if ( defined( $const ) && constant( $const ) && empty( $duplicated_keys[ constant( $const ) ] ) ) {
2136				$values[ $type ] = constant( $const );
2137			} elseif ( ! $values[ $type ] ) {
2138				$values[ $type ] = get_site_option( "{$scheme}_{$type}" );
2139				if ( ! $values[ $type ] ) {
2140					$values[ $type ] = wp_generate_password( 64, true, true );
2141					update_site_option( "{$scheme}_{$type}", $values[ $type ] );
2142				}
2143			}
2144		}
2145	} else {
2146		if ( ! $values['key'] ) {
2147			$values['key'] = get_site_option( 'secret_key' );
2148			if ( ! $values['key'] ) {
2149				$values['key'] = wp_generate_password( 64, true, true );
2150				update_site_option( 'secret_key', $values['key'] );
2151			}
2152		}
2153		$values['salt'] = hash_hmac( 'md5', $scheme, $values['key'] );
2154	}
2155
2156	$cached_salts[ $scheme ] = $values['key'] . $values['salt'];
2157
2158	/** This filter is documented in wp-includes/pluggable.php */
2159	return apply_filters( 'salt', $cached_salts[ $scheme ], $scheme );
2160}
2161endif;
2162
2163if ( !function_exists('wp_hash') ) :
2164/**
2165 * Get hash of given string.
2166 *
2167 * @since 2.0.3
2168 *
2169 * @param string $data   Plain text to hash
2170 * @param string $scheme Authentication scheme (auth, secure_auth, logged_in, nonce)
2171 * @return string Hash of $data
2172 */
2173function wp_hash($data, $scheme = 'auth') {
2174	$salt = wp_salt($scheme);
2175
2176	return hash_hmac('md5', $data, $salt);
2177}
2178endif;
2179
2180if ( !function_exists('wp_hash_password') ) :
2181/**
2182 * Create a hash (encrypt) of a plain text password.
2183 *
2184 * For integration with other applications, this function can be overwritten to
2185 * instead use the other package password checking algorithm.
2186 *
2187 * @since 2.5.0
2188 *
2189 * @global PasswordHash $wp_hasher PHPass object
2190 *
2191 * @param string $password Plain text user password to hash
2192 * @return string The hash string of the password
2193 */
2194function wp_hash_password($password) {
2195	global $wp_hasher;
2196
2197	if ( empty($wp_hasher) ) {
2198		require_once( ABSPATH . WPINC . '/class-phpass.php');
2199		// By default, use the portable hash from phpass
2200		$wp_hasher = new PasswordHash(8, true);
2201	}
2202
2203	return $wp_hasher->HashPassword( trim( $password ) );
2204}
2205endif;
2206
2207if ( !function_exists('wp_check_password') ) :
2208/**
2209 * Checks the plaintext password against the encrypted Password.
2210 *
2211 * Maintains compatibility between old version and the new cookie authentication
2212 * protocol using PHPass library. The $hash parameter is the encrypted password
2213 * and the function compares the plain text password when encrypted similarly
2214 * against the already encrypted password to see if they match.
2215 *
2216 * For integration with other applications, this function can be overwritten to
2217 * instead use the other package password checking algorithm.
2218 *
2219 * @since 2.5.0
2220 *
2221 * @global PasswordHash $wp_hasher PHPass object used for checking the password
2222 *	against the $hash + $password
2223 * @uses PasswordHash::CheckPassword
2224 *
2225 * @param string     $password Plaintext user's password
2226 * @param string     $hash     Hash of the user's password to check against.
2227 * @param string|int $user_id  Optional. User ID.
2228 * @return bool False, if the $password does not match the hashed password
2229 */
2230function wp_check_password($password, $hash, $user_id = '') {
2231	global $wp_hasher;
2232
2233	// If the hash is still md5...
2234	if ( strlen($hash) <= 32 ) {
2235		$check = hash_equals( $hash, md5( $password ) );
2236		if ( $check && $user_id ) {
2237			// Rehash using new hash.
2238			wp_set_password($password, $user_id);
2239			$hash = wp_hash_password($password);
2240		}
2241
2242		/**
2243		 * Filters whether the plaintext password matches the encrypted password.
2244		 *
2245		 * @since 2.5.0
2246		 *
2247		 * @param bool       $check    Whether the passwords match.
2248		 * @param string     $password The plaintext password.
2249		 * @param string     $hash     The hashed password.
2250		 * @param string|int $user_id  User ID. Can be empty.
2251		 */
2252		return apply_filters( 'check_password', $check, $password, $hash, $user_id );
2253	}
2254
2255	// If the stored hash is longer than an MD5, presume the
2256	// new style phpass portable hash.
2257	if ( empty($wp_hasher) ) {
2258		require_once( ABSPATH . WPINC . '/class-phpass.php');
2259		// By default, use the portable hash from phpass
2260		$wp_hasher = new PasswordHash(8, true);
2261	}
2262
2263	$check = $wp_hasher->CheckPassword($password, $hash);
2264
2265	/** This filter is documented in wp-includes/pluggable.php */
2266	return apply_filters( 'check_password', $check, $password, $hash, $user_id );
2267}
2268endif;
2269
2270if ( !function_exists('wp_generate_password') ) :
2271/**
2272 * Generates a random password drawn from the defined set of characters.
2273 *
2274 * @since 2.5.0
2275 *
2276 * @param int  $length              Optional. The length of password to generate. Default 12.
2277 * @param bool $special_chars       Optional. Whether to include standard special characters.
2278 *                                  Default true.
2279 * @param bool $extra_special_chars Optional. Whether to include other special characters.
2280 *                                  Used when generating secret keys and salts. Default false.
2281 * @return string The random password.
2282 */
2283function wp_generate_password( $length = 12, $special_chars = true, $extra_special_chars = false ) {
2284	$chars = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789';
2285	if ( $special_chars )
2286		$chars .= '!@#$%^&*()';
2287	if ( $extra_special_chars )
2288		$chars .= '-_ []{}<>~`+=,.;:/?|';
2289
2290	$password = '';
2291	for ( $i = 0; $i < $length; $i++ ) {
2292		$password .= substr($chars, wp_rand(0, strlen($chars) - 1), 1);
2293	}
2294
2295	/**
2296	 * Filters the randomly-generated password.
2297	 *
2298	 * @since 3.0.0
2299	 *
2300	 * @param string $password The generated password.
2301	 */
2302	return apply_filters( 'random_password', $password );
2303}
2304endif;
2305
2306if ( !function_exists('wp_rand') ) :
2307/**
2308 * Generates a random number
2309 *
2310 * @since 2.6.2
2311 * @since 4.4.0 Uses PHP7 random_int() or the random_compat library if available.
2312 *
2313 * @global string $rnd_value
2314 * @staticvar string $seed
2315 * @staticvar bool $external_rand_source_available
2316 *
2317 * @param int $min Lower limit for the generated number
2318 * @param int $max Upper limit for the generated number
2319 * @return int A random number between min and max
2320 */
2321function wp_rand( $min = 0, $max = 0 ) {
2322	global $rnd_value;
2323
2324	// 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.
2325	$max_random_number = 3000000000 === 2147483647 ? (float) "4294967295" : 4294967295; // 4294967295 = 0xffffffff
2326
2327	// We only handle Ints, floats are truncated to their integer value.
2328	$min = (int) $min;
2329	$max = (int) $max;
2330
2331	// Use PHP's CSPRNG, or a compatible method
2332	static $use_random_int_functionality = true;
2333	if ( $use_random_int_functionality ) {
2334		try {
2335			$_max = ( 0 != $max ) ? $max : $max_random_number;
2336			// wp_rand() can accept arguments in either order, PHP cannot.
2337			$_max = max( $min, $_max );
2338			$_min = min( $min, $_max );
2339			$val = random_int( $_min, $_max );
2340			if ( false !== $val ) {
2341				return absint( $val );
2342			} else {
2343				$use_random_int_functionality = false;
2344			}
2345		} catch ( Error $e ) {
2346			$use_random_int_functionality = false;
2347		} catch ( Exception $e ) {
2348			$use_random_int_functionality = false;
2349		}
2350	}
2351
2352	// Reset $rnd_value after 14 uses
2353	// 32(md5) + 40(sha1) + 40(sha1) / 8 = 14 random numbers from $rnd_value
2354	if ( strlen($rnd_value) < 8 ) {
2355		if ( defined( 'WP_SETUP_CONFIG' ) )
2356			static $seed = '';
2357		else
2358			$seed = get_transient('random_seed');
2359		$rnd_value = md5( uniqid(microtime() . mt_rand(), true ) . $seed );
2360		$rnd_value .= sha1($rnd_value);
2361		$rnd_value .= sha1($rnd_value . $seed);
2362		$seed = md5($seed . $rnd_value);
2363		if ( ! defined( 'WP_SETUP_CONFIG' ) && ! defined( 'WP_INSTALLING' ) ) {
2364			set_transient( 'random_seed', $seed );
2365		}
2366	}
2367
2368	// Take the first 8 digits for our value
2369	$value = substr($rnd_value, 0, 8);
2370
2371	// Strip the first eight, leaving the remainder for the next call to wp_rand().
2372	$rnd_value = substr($rnd_value, 8);
2373
2374	$value = abs(hexdec($value));
2375
2376	// Reduce the value to be within the min - max range
2377	if ( $max != 0 )
2378		$value = $min + ( $max - $min + 1 ) * $value / ( $max_random_number + 1 );
2379
2380	return abs(intval($value));
2381}
2382endif;
2383
2384if ( !function_exists('wp_set_password') ) :
2385/**
2386 * Updates the user's password with a new encrypted one.
2387 *
2388 * For integration with other applications, this function can be overwritten to
2389 * instead use the other package password checking algorithm.
2390 *
2391 * Please note: This function should be used sparingly and is really only meant for single-time
2392 * application. Leveraging this improperly in a plugin or theme could result in an endless loop
2393 * of password resets if precautions are not taken to ensure it does not execute on every page load.
2394 *
2395 * @since 2.5.0
2396 *
2397 * @global wpdb $wpdb WordPress database abstraction object.
2398 *
2399 * @param string $password The plaintext new user password
2400 * @param int    $user_id  User ID
2401 */
2402function wp_set_password( $password, $user_id ) {
2403	global $wpdb;
2404
2405	$hash = wp_hash_password( $password );
2406	$wpdb->update($wpdb->users, array('user_pass' => $hash, 'user_activation_key' => ''), array('ID' => $user_id) );
2407
2408	wp_cache_delete($user_id, 'users');
2409}
2410endif;
2411
2412if ( !function_exists( 'get_avatar' ) ) :
2413/**
2414 * Retrieve the avatar `<img>` tag for a user, email address, MD5 hash, comment, or post.
2415 *
2416 * @since 2.5.0
2417 * @since 4.2.0 Optional `$args` parameter added.
2418 *
2419 * @param mixed $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash,
2420 *                           user email, WP_User object, WP_Post object, or WP_Comment object.
2421 * @param int    $size       Optional. Height and width of the avatar image file in pixels. Default 96.
2422 * @param string $default    Optional. URL for the default image or a default type. Accepts '404'
2423 *                           (return a 404 instead of a default image), 'retro' (8bit), 'monsterid'
2424 *                           (monster), 'wavatar' (cartoon face), 'indenticon' (the "quilt"),
2425 *                           'mystery', 'mm', or 'mysteryman' (The Oyster Man), 'blank' (transparent GIF),
2426 *                           or 'gravatar_default' (the Gravatar logo). Default is the value of the
2427 *                           'avatar_default' option, with a fallback of 'mystery'.
2428 * @param string $alt        Optional. Alternative text to use in &lt;img&gt; tag. Default empty.
2429 * @param array  $args       {
2430 *     Optional. Extra arguments to retrieve the avatar.
2431 *
2432 *     @type int          $height        Display height of the avatar in pixels. Defaults to $size.
2433 *     @type int          $width         Display width of the avatar in pixels. Defaults to $size.
2434 *     @type bool         $force_default Whether to always show the default image, never the Gravatar. Default false.
2435 *     @type string       $rating        What rating to display avatars up to. Accepts 'G', 'PG', 'R', 'X', and are
2436 *                                       judged in that order. Default is the value of the 'avatar_rating' option.
2437 *     @type string       $scheme        URL scheme to use. See set_url_scheme() for accepted values.
2438 *                                       Default null.
2439 *     @type array|string $class         Array or string of additional classes to add to the &lt;img&gt; element.
2440 *                                       Default null.
2441 *     @type bool         $force_display Whether to always show the avatar - ignores the show_avatars option.
2442 *                                       Default false.
2443 *     @type string       $extra_attr    HTML attributes to insert in the IMG element. Is not sanitized. Default empty.
2444 * }
2445 * @return false|string `<img>` tag for the user's avatar. False on failure.
2446 */
2447function get_avatar( $id_or_email, $size = 96, $default = '', $alt = '', $args = null ) {
2448	$defaults = array(
2449		// get_avatar_data() args.
2450		'size'          => 96,
2451		'height'        => null,
2452		'width'         => null,
2453		'default'       => get_option( 'avatar_default', 'mystery' ),
2454		'force_default' => false,
2455		'rating'        => get_option( 'avatar_rating' ),
2456		'scheme'        => null,
2457		'alt'           => '',
2458		'class'         => null,
2459		'force_display' => false,
2460		'extra_attr'    => '',
2461	);
2462
2463	if ( empty( $args ) ) {
2464		$args = array();
2465	}
2466
2467	$args['size']    = (int) $size;
2468	$args['default'] = $default;
2469	$args['alt']     = $alt;
2470
2471	$args = wp_parse_args( $args, $defaults );
2472
2473	if ( empty( $args['height'] ) ) {
2474		$args['height'] = $args['size'];
2475	}
2476	if ( empty( $args['width'] ) ) {
2477		$args['width'] = $args['size'];
2478	}
2479
2480	if ( is_object( $id_or_email ) && isset( $id_or_email->comment_ID ) ) {
2481		$id_or_email = get_comment( $id_or_email );
2482	}
2483
2484	/**
2485	 * Filters whether to retrieve the avatar URL early.
2486	 *
2487	 * Passing a non-null value will effectively short-circuit get_avatar(), passing
2488	 * the value through the {@see 'get_avatar'} filter and returning early.
2489	 *
2490	 * @since 4.2.0
2491	 *
2492	 * @param string $avatar      HTML for the user's avatar. Default null.
2493	 * @param mixed  $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash,
2494	 *                            user email, WP_User object, WP_Post object, or WP_Comment object.
2495	 * @param array  $args        Arguments passed to get_avatar_url(), after processing.
2496	 */
2497	$avatar = apply_filters( 'pre_get_avatar', null, $id_or_email, $args );
2498
2499	if ( ! is_null( $avatar ) ) {
2500		/** This filter is documented in wp-includes/pluggable.php */
2501		return apply_filters( 'get_avatar', $avatar, $id_or_email, $args['size'], $args['default'], $args['alt'], $args );
2502	}
2503
2504	if ( ! $args['force_display'] && ! get_option( 'show_avatars' ) ) {
2505		return false;
2506	}
2507
2508	$url2x = get_avatar_url( $id_or_email, array_merge( $args, array( 'size' => $args['size'] * 2 ) ) );
2509
2510	$args = get_avatar_data( $id_or_email, $args );
2511
2512	$url = $args['url'];
2513
2514	if ( ! $url || is_wp_error( $url ) ) {
2515		return false;
2516	}
2517
2518	$class = array( 'avatar', 'avatar-' . (int) $args['size'], 'photo' );
2519
2520	if ( ! $args['found_avatar'] || $args['force_default'] ) {
2521		$class[] = 'avatar-default';
2522	}
2523
2524	if ( $args['class'] ) {
2525		if ( is_array( $args['class'] ) ) {
2526			$class = array_merge( $class, $args['class'] );
2527		} else {
2528			$class[] = $args['class'];
2529		}
2530	}
2531
2532	$avatar = sprintf(
2533		"<img alt='%s' src='%s' srcset='%s' class='%s' height='%d' width='%d' %s/>",
2534		esc_attr( $args['alt'] ),
2535		esc_url( $url ),
2536		esc_url( $url2x ) . ' 2x',
2537		esc_attr( join( ' ', $class ) ),
2538		(int) $args['height'],
2539		(int) $args['width'],
2540		$args['extra_attr']
2541	);
2542
2543	/**
2544	 * Filters the avatar to retrieve.
2545	 *
2546	 * @since 2.5.0
2547	 * @since 4.2.0 The `$args` parameter was added.
2548	 *
2549	 * @param string $avatar      &lt;img&gt; tag for the user's avatar.
2550	 * @param mixed  $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash,
2551	 *                            user email, WP_User object, WP_Post object, or WP_Comment object.
2552	 * @param int    $size        Square avatar width and height in pixels to retrieve.
2553	 * @param string $default     URL for the default image or a default type. Accepts '404', 'retro', 'monsterid',
2554	 *                            'wavatar', 'indenticon','mystery' (or 'mm', or 'mysteryman'), 'blank', or 'gravatar_default'.
2555	 *                            Default is the value of the 'avatar_default' option, with a fallback of 'mystery'.
2556	 * @param string $alt         Alternative text to use in the avatar image tag. Default empty.
2557	 * @param array  $args        Arguments passed to get_avatar_data(), after processing.
2558	 */
2559	return apply_filters( 'get_avatar', $avatar, $id_or_email, $args['size'], $args['default'], $args['alt'], $args );
2560}
2561endif;
2562
2563if ( !function_exists( 'wp_text_diff' ) ) :
2564/**
2565 * Displays a human readable HTML representation of the difference between two strings.
2566 *
2567 * The Diff is available for getting the changes between versions. The output is
2568 * HTML, so the primary use is for displaying the changes. If the two strings
2569 * are equivalent, then an empty string will be returned.
2570 *
2571 * The arguments supported and can be changed are listed below.
2572 *
2573 * 'title' : Default is an empty string. Titles the diff in a manner compatible
2574 *		with the output.
2575 * 'title_left' : Default is an empty string. Change the HTML to the left of the
2576 *		title.
2577 * 'title_right' : Default is an empty string. Change the HTML to the right of
2578 *		the title.
2579 *
2580 * @since 2.6.0
2581 *
2582 * @see wp_parse_args() Used to change defaults to user defined settings.
2583 * @uses Text_Diff
2584 * @uses WP_Text_Diff_Renderer_Table
2585 *
2586 * @param string       $left_string  "old" (left) version of string
2587 * @param string       $right_string "new" (right) version of string
2588 * @param string|array $args         Optional. Change 'title', 'title_left', and 'title_right' defaults.
2589 * @return string Empty string if strings are equivalent or HTML with differences.
2590 */
2591function wp_text_diff( $left_string, $right_string, $args = null ) {
2592	$defaults = array( 'title' => '', 'title_left' => '', 'title_right' => '' );
2593	$args = wp_parse_args( $args, $defaults );
2594
2595	if ( ! class_exists( 'WP_Text_Diff_Renderer_Table', false ) )
2596		require( ABSPATH . WPINC . '/wp-diff.php' );
2597
2598	$left_string  = normalize_whitespace($left_string);
2599	$right_string = normalize_whitespace($right_string);
2600
2601	$left_lines  = explode("\n", $left_string);
2602	$right_lines = explode("\n", $right_string);
2603	$text_diff = new Text_Diff($left_lines, $right_lines);
2604	$renderer  = new WP_Text_Diff_Renderer_Table( $args );
2605	$diff = $renderer->render($text_diff);
2606
2607	if ( !$diff )
2608		return '';
2609
2610	$r  = "<table class='diff'>\n";
2611
2612	if ( ! empty( $args[ 'show_split_view' ] ) ) {
2613		$r .= "<col class='content diffsplit left' /><col class='content diffsplit middle' /><col class='content diffsplit right' />";
2614	} else {
2615		$r .= "<col class='content' />";
2616	}
2617
2618	if ( $args['title'] || $args['title_left'] || $args['title_right'] )
2619		$r .= "<thead>";
2620	if ( $args['title'] )
2621		$r .= "<tr class='diff-title'><th colspan='4'>$args[title]</th></tr>\n";
2622	if ( $args['title_left'] || $args['title_right'] ) {
2623		$r .= "<tr class='diff-sub-title'>\n";
2624		$r .= "\t<td></td><th>$args[title_left]</th>\n";
2625		$r .= "\t<td></td><th>$args[title_right]</th>\n";
2626		$r .= "</tr>\n";
2627	}
2628	if ( $args['title'] || $args['title_left'] || $args['title_right'] )
2629		$r .= "</thead>\n";
2630
2631	$r .= "<tbody>\n$diff\n</tbody>\n";
2632	$r .= "</table>";
2633
2634	return $r;
2635}
2636endif;