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