wp-includes/pluggable.php

   1 <?php
   2 /**
   3  * These functions can be replaced via plugins. If plugins do not redefine these
   4  * functions, then these will be used instead.
   5  *
   6  * @package WordPress
   7  */
   8
   9 if ( !function_exists('wp_set_current_user') ) :
  10 /**
  11  * Changes the current user by ID or name.
  12  *
  13  * Set $id to null and specify a name if you do not know a user's ID.
  14  *
  15  * Some WordPress functionality is based on the current user and not based on
  16  * the signed in user. Therefore, it opens the ability to edit and perform
  17  * actions on users who aren't signed in.
  18  *
  19  * @since 2.0.3
  20  * @global object $current_user The current user object which holds the user data.
  21  * @uses do_action() Calls 'set_current_user' hook after setting the current user.
  22  *
  23  * @param int $id User ID
  24  * @param string $name User's username
  25  * @return WP_User Current user User object
  26  */
  27 function wp_set_current_user($id, $name = '') {
  28         global $current_user;
  29
  30         if ( isset( $current_user ) && ( $current_user instanceof WP_User ) && ( $id == $current_user->ID ) )
  31                 return $current_user;
  32
  33         $current_user = new WP_User( $id, $name );
  34
  35         setup_userdata( $current_user->ID );
  36
  37         do_action('set_current_user');
  38
  39         return $current_user;
  40 }
  41 endif;
  42
  43 if ( !function_exists('wp_get_current_user') ) :
  44 /**
  45  * Retrieve the current user object.
  46  *
  47  * @since 2.0.3
  48  *
  49  * @return WP_User Current user WP_User object
  50  */
  51 function wp_get_current_user() {
  52         global $current_user;
  53
  54         get_currentuserinfo();
  55
  56         return $current_user;
  57 }
  58 endif;
  59
  60 if ( !function_exists('get_currentuserinfo') ) :
  61 /**
  62  * Populate global variables with information about the currently logged in user.
  63  *
  64  * Will set the current user, if the current user is not set. The current user
  65  * will be set to the logged in person. If no user is logged in, then it will
  66  * set the current user to 0, which is invalid and won't have any permissions.
  67  *
  68  * @since 0.71
  69  * @uses $current_user Checks if the current user is set
  70  * @uses wp_validate_auth_cookie() Retrieves current logged in user.
  71  *
  72  * @return bool|null False on XMLRPC Request and invalid auth cookie. Null when current user set
  73  */
  74 function get_currentuserinfo() {
  75         global $current_user;
  76
  77         if ( ! empty( $current_user ) ) {
  78                 if ( $current_user instanceof WP_User )
  79                         return;
  80
  81                 // Upgrade stdClass to WP_User
  82                 if ( is_object( $current_user ) && isset( $current_user->ID ) ) {
  83                         $cur_id = $current_user->ID;
  84                         $current_user = null;
  85                         wp_set_current_user( $cur_id );
  86                         return;
  87                 }
  88
  89                 // $current_user has a junk value. Force to WP_User with ID 0.
  90                 $current_user = null;
  91                 wp_set_current_user( 0 );
  92                 return false;
  93         }
  94
  95         if ( defined('XMLRPC_REQUEST') && XMLRPC_REQUEST ) {
  96                 wp_set_current_user( 0 );
  97                 return false;
  98         }
  99
 100         if ( ! $user = wp_validate_auth_cookie() ) {
 101                  if ( is_blog_admin() || is_network_admin() || empty( $_COOKIE[LOGGED_IN_COOKIE] ) || !$user = wp_validate_auth_cookie( $_COOKIE[LOGGED_IN_COOKIE], 'logged_in' ) ) {
 102                         wp_set_current_user( 0 );
 103                         return false;
 104                  }
 105         }
 106
 107         wp_set_current_user( $user );
 108 }
 109 endif;
 110
 111 if ( !function_exists('get_userdata') ) :
 112 /**
 113  * Retrieve user info by user ID.
 114  *
 115  * @since 0.71
 116  *
 117  * @param int $user_id User ID
 118  * @return bool|object False on failure, WP_User object on success
 119  */
 120 function get_userdata( $user_id ) {
 121         return get_user_by( 'id', $user_id );
 122 }
 123 endif;
 124
 125 if ( !function_exists('get_user_by') ) :
 126 /**
 127  * Retrieve user info by a given field
 128  *
 129  * @since 2.8.0
 130  *
 131  * @param string $field The field to retrieve the user with. id | slug | email | login
 132  * @param int|string $value A value for $field. A user ID, slug, email address, or login name.
 133  * @return bool|object False on failure, WP_User object on success
 134  */
 135 function get_user_by( $field, $value ) {
 136         $userdata = WP_User::get_data_by( $field, $value );
 137
 138         if ( !$userdata )
 139                 return false;
 140
 141         $user = new WP_User;
 142         $user->init( $userdata );
 143
 144         return $user;
 145 }
 146 endif;
 147
 148 if ( !function_exists('cache_users') ) :
 149 /**
 150  * Retrieve info for user lists to prevent multiple queries by get_userdata()
 151  *
 152  * @since 3.0.0
 153  *
 154  * @param array $user_ids User ID numbers list
 155  */
 156 function cache_users( $user_ids ) {
 157         global $wpdb;
 158
 159         $clean = _get_non_cached_ids( $user_ids, 'users' );
 160
 161         if ( empty( $clean ) )
 162                 return;
 163
 164         $list = implode( ',', $clean );
 165
 166         $users = $wpdb->get_results( "SELECT * FROM $wpdb->users WHERE ID IN ($list)" );
 167
 168         $ids = array();
 169         foreach ( $users as $user ) {
 170                 update_user_caches( $user );
 171                 $ids[] = $user->ID;
 172         }
 173         update_meta_cache( 'user', $ids );
 174 }
 175 endif;
 176
 177 if ( !function_exists( 'wp_mail' ) ) :
 178 /**
 179  * Send mail, similar to PHP's mail
 180  *
 181  * A true return value does not automatically mean that the user received the
 182  * email successfully. It just only means that the method used was able to
 183  * process the request without any errors.
 184  *
 185  * Using the two 'wp_mail_from' and 'wp_mail_from_name' hooks allow from
 186  * creating a from address like 'Name <email@address.com>' when both are set. If
 187  * just 'wp_mail_from' is set, then just the email address will be used with no
 188  * name.
 189  *
 190  * The default content type is 'text/plain' which does not allow using HTML.
 191  * However, you can set the content type of the email by using the
 192  * 'wp_mail_content_type' filter.
 193  *
 194  * The default charset is based on the charset used on the blog. The charset can
 195  * be set using the 'wp_mail_charset' filter.
 196  *
 197  * @since 1.2.1
 198  * @uses apply_filters() Calls 'wp_mail' hook on an array of all of the parameters.
 199  * @uses apply_filters() Calls 'wp_mail_from' hook to get the from email address.
 200  * @uses apply_filters() Calls 'wp_mail_from_name' hook to get the from address name.
 201  * @uses apply_filters() Calls 'wp_mail_content_type' hook to get the email content type.
 202  * @uses apply_filters() Calls 'wp_mail_charset' hook to get the email charset
 203  * @uses do_action_ref_array() Calls 'phpmailer_init' hook on the reference to
 204  *              phpmailer object.
 205  * @uses PHPMailer
 206  *
 207  * @param string|array $to Array or comma-separated list of email addresses to send message.
 208  * @param string $subject Email subject
 209  * @param string $message Message contents
 210  * @param string|array $headers Optional. Additional headers.
 211  * @param string|array $attachments Optional. Files to attach.
 212  * @return bool Whether the email contents were sent successfully.
 213  */
 214 function wp_mail( $to, $subject, $message, $headers = '', $attachments = array() ) {
 215         // Compact the input, apply the filters, and extract them back out
 216         extract( apply_filters( 'wp_mail', compact( 'to', 'subject', 'message', 'headers', 'attachments' ) ) );
 217
 218         if ( !is_array($attachments) )
 219                 $attachments = explode( "\n", str_replace( "\r\n", "\n", $attachments ) );
 220
 221         global $phpmailer;
 222
 223         // (Re)create it, if it's gone missing
 224         if ( !is_object( $phpmailer ) || !is_a( $phpmailer, 'PHPMailer' ) ) {
 225                 require_once ABSPATH . WPINC . '/class-phpmailer.php';
 226                 require_once ABSPATH . WPINC . '/class-smtp.php';
 227                 $phpmailer = new PHPMailer( true );
 228         }
 229
 230         // Headers
 231         if ( empty( $headers ) ) {
 232                 $headers = array();
 233         } else {
 234                 if ( !is_array( $headers ) ) {
 235                         // Explode the headers out, so this function can take both
 236                         // string headers and an array of headers.
 237                         $tempheaders = explode( "\n", str_replace( "\r\n", "\n", $headers ) );
 238                 } else {
 239                         $tempheaders = $headers;
 240                 }
 241                 $headers = array();
 242                 $cc = array();
 243                 $bcc = array();
 244
 245                 // If it's actually got contents
 246                 if ( !empty( $tempheaders ) ) {
 247                         // Iterate through the raw headers
 248                         foreach ( (array) $tempheaders as $header ) {
 249                                 if ( strpos($header, ':') === false ) {
 250                                         if ( false !== stripos( $header, 'boundary=' ) ) {
 251                                                 $parts = preg_split('/boundary=/i', trim( $header ) );
 252                                                 $boundary = trim( str_replace( array( "'", '"' ), '', $parts[1] ) );
 253                                         }
 254                                         continue;
 255                                 }
 256                                 // Explode them out
 257                                 list( $name, $content ) = explode( ':', trim( $header ), 2 );
 258
 259                                 // Cleanup crew
 260                                 $name    = trim( $name    );
 261                                 $content = trim( $content );
 262
 263                                 switch ( strtolower( $name ) ) {
 264                                         // Mainly for legacy -- process a From: header if it's there
 265                                         case 'from':
 266                                                 if ( strpos($content, '<' ) !== false ) {
 267                                                         // So... making my life hard again?
 268                                                         $from_name = substr( $content, 0, strpos( $content, '<' ) - 1 );
 269                                                         $from_name = str_replace( '"', '', $from_name );
 270                                                         $from_name = trim( $from_name );
 271
 272                                                         $from_email = substr( $content, strpos( $content, '<' ) + 1 );
 273                                                         $from_email = str_replace( '>', '', $from_email );
 274                                                         $from_email = trim( $from_email );
 275                                                 } else {
 276                                                         $from_email = trim( $content );
 277                                                 }
 278                                                 break;
 279                                         case 'content-type':
 280                                                 if ( strpos( $content, ';' ) !== false ) {
 281                                                         list( $type, $charset ) = explode( ';', $content );
 282                                                         $content_type = trim( $type );
 283                                                         if ( false !== stripos( $charset, 'charset=' ) ) {
 284                                                                 $charset = trim( str_replace( array( 'charset=', '"' ), '', $charset ) );
 285                                                         } elseif ( false !== stripos( $charset, 'boundary=' ) ) {
 286                                                                 $boundary = trim( str_replace( array( 'BOUNDARY=', 'boundary=', '"' ), '', $charset ) );
 287                                                                 $charset = '';
 288                                                         }
 289                                                 } else {
 290                                                         $content_type = trim( $content );
 291                                                 }
 292                                                 break;
 293                                         case 'cc':
 294                                                 $cc = array_merge( (array) $cc, explode( ',', $content ) );
 295                                                 break;
 296                                         case 'bcc':
 297                                                 $bcc = array_merge( (array) $bcc, explode( ',', $content ) );
 298                                                 break;
 299                                         default:
 300                                                 // Add it to our grand headers array
 301                                                 $headers[trim( $name )] = trim( $content );
 302                                                 break;
 303                                 }
 304                         }
 305                 }
 306         }
 307
 308         // Empty out the values that may be set
 309         $phpmailer->ClearAddresses();
 310         $phpmailer->ClearAllRecipients();
 311         $phpmailer->ClearAttachments();
 312         $phpmailer->ClearBCCs();
 313         $phpmailer->ClearCCs();
 314         $phpmailer->ClearCustomHeaders();
 315         $phpmailer->ClearReplyTos();
 316
 317         // From email and name
 318         // If we don't have a name from the input headers
 319         if ( !isset( $from_name ) )
 320                 $from_name = 'WordPress';
 321
 322         /* If we don't have an email from the input headers default to wordpress@$sitename
 323          * Some hosts will block outgoing mail from this address if it doesn't exist but
 324          * there's no easy alternative. Defaulting to admin_email might appear to be another
 325          * option but some hosts may refuse to relay mail from an unknown domain. See
 326          * http://trac.wordpress.org/ticket/5007.
 327          */
 328
 329         if ( !isset( $from_email ) ) {
 330                 // Get the site domain and get rid of www.
 331                 $sitename = strtolower( $_SERVER['SERVER_NAME'] );
 332                 if ( substr( $sitename, 0, 4 ) == 'www.' ) {
 333                         $sitename = substr( $sitename, 4 );
 334                 }
 335
 336                 $from_email = 'wordpress@' . $sitename;
 337         }
 338
 339         // Plugin authors can override the potentially troublesome default
 340         $phpmailer->From     = apply_filters( 'wp_mail_from'     , $from_email );
 341         $phpmailer->FromName = apply_filters( 'wp_mail_from_name', $from_name  );
 342
 343         // Set destination addresses
 344         if ( !is_array( $to ) )
 345                 $to = explode( ',', $to );
 346
 347         foreach ( (array) $to as $recipient ) {
 348                 try {
 349                         // Break $recipient into name and address parts if in the format "Foo <bar@baz.com>"
 350                         $recipient_name = '';
 351                         if( preg_match( '/(.*)<(.+)>/', $recipient, $matches ) ) {
 352                                 if ( count( $matches ) == 3 ) {
 353                                         $recipient_name = $matches[1];
 354                                         $recipient = $matches[2];
 355                                 }
 356                         }
 357                         $phpmailer->AddAddress( $recipient, $recipient_name);
 358                 } catch ( phpmailerException $e ) {
 359                         continue;
 360                 }
 361         }
 362
 363         // Set mail's subject and body
 364         $phpmailer->Subject = $subject;
 365         $phpmailer->Body    = $message;
 366
 367         // Add any CC and BCC recipients
 368         if ( !empty( $cc ) ) {
 369                 foreach ( (array) $cc as $recipient ) {
 370                         try {
 371                                 // Break $recipient into name and address parts if in the format "Foo <bar@baz.com>"
 372                                 $recipient_name = '';
 373                                 if( preg_match( '/(.*)<(.+)>/', $recipient, $matches ) ) {
 374                                         if ( count( $matches ) == 3 ) {
 375                                                 $recipient_name = $matches[1];
 376                                                 $recipient = $matches[2];
 377                                         }
 378                                 }
 379                                 $phpmailer->AddCc( $recipient, $recipient_name );
 380                         } catch ( phpmailerException $e ) {
 381                                 continue;
 382                         }
 383                 }
 384         }
 385
 386         if ( !empty( $bcc ) ) {
 387                 foreach ( (array) $bcc as $recipient) {
 388                         try {
 389                                 // Break $recipient into name and address parts if in the format "Foo <bar@baz.com>"
 390                                 $recipient_name = '';
 391                                 if( preg_match( '/(.*)<(.+)>/', $recipient, $matches ) ) {
 392                                         if ( count( $matches ) == 3 ) {
 393                                                 $recipient_name = $matches[1];
 394                                                 $recipient = $matches[2];
 395                                         }
 396                                 }
 397                                 $phpmailer->AddBcc( $recipient, $recipient_name );
 398                         } catch ( phpmailerException $e ) {
 399                                 continue;
 400                         }
 401                 }
 402         }
 403
 404         // Set to use PHP's mail()
 405         $phpmailer->IsMail();
 406
 407         // Set Content-Type and charset
 408         // If we don't have a content-type from the input headers
 409         if ( !isset( $content_type ) )
 410                 $content_type = 'text/plain';
 411
 412         $content_type = apply_filters( 'wp_mail_content_type', $content_type );
 413
 414         $phpmailer->ContentType = $content_type;
 415
 416         // Set whether it's plaintext, depending on $content_type
 417         if ( 'text/html' == $content_type )
 418                 $phpmailer->IsHTML( true );
 419
 420         // If we don't have a charset from the input headers
 421         if ( !isset( $charset ) )
 422                 $charset = get_bloginfo( 'charset' );
 423
 424         // Set the content-type and charset
 425         $phpmailer->CharSet = apply_filters( 'wp_mail_charset', $charset );
 426
 427         // Set custom headers
 428         if ( !empty( $headers ) ) {
 429                 foreach( (array) $headers as $name => $content ) {
 430                         $phpmailer->AddCustomHeader( sprintf( '%1$s: %2$s', $name, $content ) );
 431                 }
 432
 433                 if ( false !== stripos( $content_type, 'multipart' ) && ! empty($boundary) )
 434                         $phpmailer->AddCustomHeader( sprintf( "Content-Type: %s;\n\t boundary=\"%s\"", $content_type, $boundary ) );
 435         }
 436
 437         if ( !empty( $attachments ) ) {
 438                 foreach ( $attachments as $attachment ) {
 439                         try {
 440                                 $phpmailer->AddAttachment($attachment);
 441                         } catch ( phpmailerException $e ) {
 442                                 continue;
 443                         }
 444                 }
 445         }
 446
 447         do_action_ref_array( 'phpmailer_init', array( &$phpmailer ) );
 448
 449         // Send!
 450         try {
 451                 return $phpmailer->Send();
 452         } catch ( phpmailerException $e ) {
 453                 return false;
 454         }
 455 }
 456 endif;
 457
 458 if ( !function_exists('wp_authenticate') ) :
 459 /**
 460  * Checks a user's login information and logs them in if it checks out.
 461  *
 462  * @since 2.5.0
 463  *
 464  * @param string $username User's username
 465  * @param string $password User's password
 466  * @return WP_Error|WP_User WP_User object if login successful, otherwise WP_Error object.
 467  */
 468 function wp_authenticate($username, $password) {
 469         $username = sanitize_user($username);
 470         $password = trim($password);
 471
 472         $user = apply_filters('authenticate', null, $username, $password);
 473
 474         if ( $user == null ) {
 475                 // TODO what should the error message be? (Or would these even happen?)
 476                 // Only needed if all authentication handlers fail to return anything.
 477                 $user = new WP_Error('authentication_failed', __('<strong>ERROR</strong>: Invalid username or incorrect password.'));
 478         }
 479
 480         $ignore_codes = array('empty_username', 'empty_password');
 481
 482         if (is_wp_error($user) && !in_array($user->get_error_code(), $ignore_codes) ) {
 483                 do_action('wp_login_failed', $username);
 484         }
 485
 486         return $user;
 487 }
 488 endif;
 489
 490 if ( !function_exists('wp_logout') ) :
 491 /**
 492  * Log the current user out.
 493  *
 494  * @since 2.5.0
 495  */
 496 function wp_logout() {
 497         wp_clear_auth_cookie();
 498         do_action('wp_logout');
 499 }
 500 endif;
 501
 502 if ( !function_exists('wp_validate_auth_cookie') ) :
 503 /**
 504  * Validates authentication cookie.
 505  *
 506  * The checks include making sure that the authentication cookie is set and
 507  * pulling in the contents (if $cookie is not used).
 508  *
 509  * Makes sure the cookie is not expired. Verifies the hash in cookie is what is
 510  * should be and compares the two.
 511  *
 512  * @since 2.5
 513  *
 514  * @param string $cookie Optional. If used, will validate contents instead of cookie's
 515  * @param string $scheme Optional. The cookie scheme to use: auth, secure_auth, or logged_in
 516  * @return bool|int False if invalid cookie, User ID if valid.
 517  */
 518 function wp_validate_auth_cookie($cookie = '', $scheme = '') {
 519         if ( ! $cookie_elements = wp_parse_auth_cookie($cookie, $scheme) ) {
 520                 do_action('auth_cookie_malformed', $cookie, $scheme);
 521                 return false;
 522         }
 523
 524         extract($cookie_elements, EXTR_OVERWRITE);
 525
 526         $expired = $expiration;
 527
 528         // Allow a grace period for POST and AJAX requests
 529         if ( defined('DOING_AJAX') || 'POST' == $_SERVER['REQUEST_METHOD'] )
 530                 $expired += HOUR_IN_SECONDS;
 531
 532         // Quick check to see if an honest cookie has expired
 533         if ( $expired < time() ) {
 534                 do_action('auth_cookie_expired', $cookie_elements);
 535                 return false;
 536         }
 537
 538         $user = get_user_by('login', $username);
 539         if ( ! $user ) {
 540                 do_action('auth_cookie_bad_username', $cookie_elements);
 541                 return false;
 542         }
 543
 544         $pass_frag = substr($user->user_pass, 8, 4);
 545
 546         $key = wp_hash($username . $pass_frag . '|' . $expiration, $scheme);
 547         $hash = hash_hmac('md5', $username . '|' . $expiration, $key);
 548
 549         if ( $hmac != $hash ) {
 550                 do_action('auth_cookie_bad_hash', $cookie_elements);
 551                 return false;
 552         }
 553
 554         if ( $expiration < time() ) // AJAX/POST grace period set above
 555                 $GLOBALS['login_grace_period'] = 1;
 556
 557         do_action('auth_cookie_valid', $cookie_elements, $user);
 558
 559         return $user->ID;
 560 }
 561 endif;
 562
 563 if ( !function_exists('wp_generate_auth_cookie') ) :
 564 /**
 565  * Generate authentication cookie contents.
 566  *
 567  * @since 2.5
 568  * @uses apply_filters() Calls 'auth_cookie' hook on $cookie contents, User ID
 569  *              and expiration of cookie.
 570  *
 571  * @param int $user_id User ID
 572  * @param int $expiration Cookie expiration in seconds
 573  * @param string $scheme Optional. The cookie scheme to use: auth, secure_auth, or logged_in
 574  * @return string Authentication cookie contents
 575  */
 576 function wp_generate_auth_cookie($user_id, $expiration, $scheme = 'auth') {
 577         $user = get_userdata($user_id);
 578
 579         $pass_frag = substr($user->user_pass, 8, 4);
 580
 581         $key = wp_hash($user->user_login . $pass_frag . '|' . $expiration, $scheme);
 582         $hash = hash_hmac('md5', $user->user_login . '|' . $expiration, $key);
 583
 584         $cookie = $user->user_login . '|' . $expiration . '|' . $hash;
 585
 586         return apply_filters('auth_cookie', $cookie, $user_id, $expiration, $scheme);
 587 }
 588 endif;
 589
 590 if ( !function_exists('wp_parse_auth_cookie') ) :
 591 /**
 592  * Parse a cookie into its components
 593  *
 594  * @since 2.7
 595  *
 596  * @param string $cookie
 597  * @param string $scheme Optional. The cookie scheme to use: auth, secure_auth, or logged_in
 598  * @return array Authentication cookie components
 599  */
 600 function wp_parse_auth_cookie($cookie = '', $scheme = '') {
 601         if ( empty($cookie) ) {
 602                 switch ($scheme){
 603                         case 'auth':
 604                                 $cookie_name = AUTH_COOKIE;
 605                                 break;
 606                         case 'secure_auth':
 607                                 $cookie_name = SECURE_AUTH_COOKIE;
 608                                 break;
 609                         case "logged_in":
 610                                 $cookie_name = LOGGED_IN_COOKIE;
 611                                 break;
 612                         default:
 613                                 if ( is_ssl() ) {
 614                                         $cookie_name = SECURE_AUTH_COOKIE;
 615                                         $scheme = 'secure_auth';
 616                                 } else {
 617                                         $cookie_name = AUTH_COOKIE;
 618                                         $scheme = 'auth';
 619                                 }
 620             }
 621
 622                 if ( empty($_COOKIE[$cookie_name]) )
 623                         return false;
 624                 $cookie = $_COOKIE[$cookie_name];
 625         }
 626
 627         $cookie_elements = explode('|', $cookie);
 628         if ( count($cookie_elements) != 3 )
 629                 return false;
 630
 631         list($username, $expiration, $hmac) = $cookie_elements;
 632
 633         return compact('username', 'expiration', 'hmac', 'scheme');
 634 }
 635 endif;
 636
 637 if ( !function_exists('wp_set_auth_cookie') ) :
 638 /**
 639  * Sets the authentication cookies based User ID.
 640  *
 641  * The $remember parameter increases the time that the cookie will be kept. The
 642  * default the cookie is kept without remembering is two days. When $remember is
 643  * set, the cookies will be kept for 14 days or two weeks.
 644  *
 645  * @since 2.5
 646  *
 647  * @param int $user_id User ID
 648  * @param bool $remember Whether to remember the user
 649  */
 650 function wp_set_auth_cookie($user_id, $remember = false, $secure = '') {
 651         if ( $remember ) {
 652                 $expiration = $expire = time() + apply_filters('auth_cookie_expiration', 14 * DAY_IN_SECONDS, $user_id, $remember);
 653         } else {
 654                 $expiration = time() + apply_filters('auth_cookie_expiration', 2 * DAY_IN_SECONDS, $user_id, $remember);
 655                 $expire = 0;
 656         }
 657
 658         if ( '' === $secure )
 659                 $secure = is_ssl();
 660
 661         $secure = apply_filters('secure_auth_cookie', $secure, $user_id);
 662         $secure_logged_in_cookie = apply_filters('secure_logged_in_cookie', false, $user_id, $secure);
 663
 664         if ( $secure ) {
 665                 $auth_cookie_name = SECURE_AUTH_COOKIE;
 666                 $scheme = 'secure_auth';
 667         } else {
 668                 $auth_cookie_name = AUTH_COOKIE;
 669                 $scheme = 'auth';
 670         }
 671
 672         $auth_cookie = wp_generate_auth_cookie($user_id, $expiration, $scheme);
 673         $logged_in_cookie = wp_generate_auth_cookie($user_id, $expiration, 'logged_in');
 674
 675         do_action('set_auth_cookie', $auth_cookie, $expire, $expiration, $user_id, $scheme);
 676         do_action('set_logged_in_cookie', $logged_in_cookie, $expire, $expiration, $user_id, 'logged_in');
 677
 678         setcookie($auth_cookie_name, $auth_cookie, $expire, PLUGINS_COOKIE_PATH, COOKIE_DOMAIN, $secure, true);
 679         setcookie($auth_cookie_name, $auth_cookie, $expire, ADMIN_COOKIE_PATH, COOKIE_DOMAIN, $secure, true);
 680         setcookie(LOGGED_IN_COOKIE, $logged_in_cookie, $expire, COOKIEPATH, COOKIE_DOMAIN, $secure_logged_in_cookie, true);
 681         if ( COOKIEPATH != SITECOOKIEPATH )
 682                 setcookie(LOGGED_IN_COOKIE, $logged_in_cookie, $expire, SITECOOKIEPATH, COOKIE_DOMAIN, $secure_logged_in_cookie, true);
 683 }
 684 endif;
 685
 686 if ( !function_exists('wp_clear_auth_cookie') ) :
 687 /**
 688  * Removes all of the cookies associated with authentication.
 689  *
 690  * @since 2.5
 691  */
 692 function wp_clear_auth_cookie() {
 693         do_action('clear_auth_cookie');
 694
 695         setcookie( AUTH_COOKIE,        ' ', time() - YEAR_IN_SECONDS, ADMIN_COOKIE_PATH,   COOKIE_DOMAIN );
 696         setcookie( SECURE_AUTH_COOKIE, ' ', time() - YEAR_IN_SECONDS, ADMIN_COOKIE_PATH,   COOKIE_DOMAIN );
 697         setcookie( AUTH_COOKIE,        ' ', time() - YEAR_IN_SECONDS, PLUGINS_COOKIE_PATH, COOKIE_DOMAIN );
 698         setcookie( SECURE_AUTH_COOKIE, ' ', time() - YEAR_IN_SECONDS, PLUGINS_COOKIE_PATH, COOKIE_DOMAIN );
 699         setcookie( LOGGED_IN_COOKIE,   ' ', time() - YEAR_IN_SECONDS, COOKIEPATH,          COOKIE_DOMAIN );
 700         setcookie( LOGGED_IN_COOKIE,   ' ', time() - YEAR_IN_SECONDS, SITECOOKIEPATH,      COOKIE_DOMAIN );
 701
 702         // Old cookies
 703         setcookie( AUTH_COOKIE,        ' ', time() - YEAR_IN_SECONDS, COOKIEPATH,     COOKIE_DOMAIN );
 704         setcookie( AUTH_COOKIE,        ' ', time() - YEAR_IN_SECONDS, SITECOOKIEPATH, COOKIE_DOMAIN );
 705         setcookie( SECURE_AUTH_COOKIE, ' ', time() - YEAR_IN_SECONDS, COOKIEPATH,     COOKIE_DOMAIN );
 706         setcookie( SECURE_AUTH_COOKIE, ' ', time() - YEAR_IN_SECONDS, SITECOOKIEPATH, COOKIE_DOMAIN );
 707
 708         // Even older cookies
 709         setcookie( USER_COOKIE, ' ', time() - YEAR_IN_SECONDS, COOKIEPATH,     COOKIE_DOMAIN );
 710         setcookie( PASS_COOKIE, ' ', time() - YEAR_IN_SECONDS, COOKIEPATH,     COOKIE_DOMAIN );
 711         setcookie( USER_COOKIE, ' ', time() - YEAR_IN_SECONDS, SITECOOKIEPATH, COOKIE_DOMAIN );
 712         setcookie( PASS_COOKIE, ' ', time() - YEAR_IN_SECONDS, SITECOOKIEPATH, COOKIE_DOMAIN );
 713 }
 714 endif;
 715
 716 if ( !function_exists('is_user_logged_in') ) :
 717 /**
 718  * Checks if the current visitor is a logged in user.
 719  *
 720  * @since 2.0.0
 721  *
 722  * @return bool True if user is logged in, false if not logged in.
 723  */
 724 function is_user_logged_in() {
 725         $user = wp_get_current_user();
 726
 727         if ( ! $user->exists() )
 728                 return false;
 729
 730         return true;
 731 }
 732 endif;
 733
 734 if ( !function_exists('auth_redirect') ) :
 735 /**
 736  * Checks if a user is logged in, if not it redirects them to the login page.
 737  *
 738  * @since 1.5
 739  */
 740 function auth_redirect() {
 741         // Checks if a user is logged in, if not redirects them to the login page
 742
 743         $secure = ( is_ssl() || force_ssl_admin() );
 744
 745         $secure = apply_filters('secure_auth_redirect', $secure);
 746
 747         // If https is required and request is http, redirect
 748         if ( $secure && !is_ssl() && false !== strpos($_SERVER['REQUEST_URI'], 'wp-admin') ) {
 749                 if ( 0 === strpos( $_SERVER['REQUEST_URI'], 'http' ) ) {
 750                         wp_redirect( set_url_scheme( $_SERVER['REQUEST_URI'], 'https' ) );
 751                         exit();
 752                 } else {
 753                         wp_redirect( 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );
 754                         exit();
 755                 }
 756         }
 757
 758         if ( is_user_admin() )
 759                 $scheme = 'logged_in';
 760         else
 761                 $scheme = apply_filters( 'auth_redirect_scheme', '' );
 762
 763         if ( $user_id = wp_validate_auth_cookie( '',  $scheme) ) {
 764                 do_action('auth_redirect', $user_id);
 765
 766                 // If the user wants ssl but the session is not ssl, redirect.
 767                 if ( !$secure && get_user_option('use_ssl', $user_id) && false !== strpos($_SERVER['REQUEST_URI'], 'wp-admin') ) {
 768                         if ( 0 === strpos( $_SERVER['REQUEST_URI'], 'http' ) ) {
 769                                 wp_redirect( set_url_scheme( $_SERVER['REQUEST_URI'], 'https' ) );
 770                                 exit();
 771                         } else {
 772                                 wp_redirect( 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );
 773                                 exit();
 774                         }
 775                 }
 776
 777                 return;  // The cookie is good so we're done
 778         }
 779
 780         // The cookie is no good so force login
 781         nocache_headers();
 782
 783         $redirect = ( strpos( $_SERVER['REQUEST_URI'], '/options.php' ) && wp_get_referer() ) ? wp_get_referer() : set_url_scheme( 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );
 784
 785         $login_url = wp_login_url($redirect, true);
 786
 787         wp_redirect($login_url);
 788         exit();
 789 }
 790 endif;
 791
 792 if ( !function_exists('check_admin_referer') ) :
 793 /**
 794  * Makes sure that a user was referred from another admin page.
 795  *
 796  * To avoid security exploits.
 797  *
 798  * @since 1.2.0
 799  * @uses do_action() Calls 'check_admin_referer' on $action.
 800  *
 801  * @param string $action Action nonce
 802  * @param string $query_arg where to look for nonce in $_REQUEST (since 2.5)
 803  */
 804 function check_admin_referer($action = -1, $query_arg = '_wpnonce') {
 805         if ( -1 == $action )
 806                 _doing_it_wrong( __FUNCTION__, __( 'You should specify a nonce action to be verified by using the first parameter.' ), '3.2' );
 807
 808         $adminurl = strtolower(admin_url());
 809         $referer = strtolower(wp_get_referer());
 810         $result = isset($_REQUEST[$query_arg]) ? wp_verify_nonce($_REQUEST[$query_arg], $action) : false;
 811         if ( !$result && !(-1 == $action && strpos($referer, $adminurl) === 0) ) {
 812                 wp_nonce_ays($action);
 813                 die();
 814         }
 815         do_action('check_admin_referer', $action, $result);
 816         return $result;
 817 }
 818 endif;
 819
 820 if ( !function_exists('check_ajax_referer') ) :
 821 /**
 822  * Verifies the AJAX request to prevent processing requests external of the blog.
 823  *
 824  * @since 2.0.3
 825  *
 826  * @param string $action Action nonce
 827  * @param string $query_arg where to look for nonce in $_REQUEST (since 2.5)
 828  */
 829 function check_ajax_referer( $action = -1, $query_arg = false, $die = true ) {
 830         if ( $query_arg )
 831                 $nonce = $_REQUEST[$query_arg];
 832         else
 833                 $nonce = isset($_REQUEST['_ajax_nonce']) ? $_REQUEST['_ajax_nonce'] : $_REQUEST['_wpnonce'];
 834
 835         $result = wp_verify_nonce( $nonce, $action );
 836
 837         if ( $die && false == $result ) {
 838                 if ( defined( 'DOING_AJAX' ) && DOING_AJAX )
 839                         wp_die( -1 );
 840                 else
 841                         die( '-1' );
 842         }
 843
 844         do_action('check_ajax_referer', $action, $result);
 845
 846         return $result;
 847 }
 848 endif;
 849
 850 if ( !function_exists('wp_redirect') ) :
 851 /**
 852  * Redirects to another page.
 853  *
 854  * @since 1.5.1
 855  * @uses apply_filters() Calls 'wp_redirect' hook on $location and $status.
 856  *
 857  * @param string $location The path to redirect to
 858  * @param int $status Status code to use
 859  * @return bool False if $location is not set
 860  */
 861 function wp_redirect($location, $status = 302) {
 862         global $is_IIS;
 863
 864         $location = apply_filters('wp_redirect', $location, $status);
 865         $status = apply_filters('wp_redirect_status', $status, $location);
 866
 867         if ( !$location ) // allows the wp_redirect filter to cancel a redirect
 868                 return false;
 869
 870         $location = wp_sanitize_redirect($location);
 871
 872         if ( !$is_IIS && php_sapi_name() != 'cgi-fcgi' )
 873                 status_header($status); // This causes problems on IIS and some FastCGI setups
 874
 875         header("Location: $location", true, $status);
 876 }
 877 endif;
 878
 879 if ( !function_exists('wp_sanitize_redirect') ) :
 880 /**
 881  * Sanitizes a URL for use in a redirect.
 882  *
 883  * @since 2.3
 884  *
 885  * @return string redirect-sanitized URL
 886  **/
 887 function wp_sanitize_redirect($location) {
 888         $location = preg_replace('|[^a-z0-9-~+_.?#=&;,/:%!]|i', '', $location);
 889         $location = wp_kses_no_null($location);
 890
 891         // remove %0d and %0a from location
 892         $strip = array('%0d', '%0a', '%0D', '%0A');
 893         $location = _deep_replace($strip, $location);
 894         return $location;
 895 }
 896 endif;
 897
 898 if ( !function_exists('wp_safe_redirect') ) :
 899 /**
 900  * Performs a safe (local) redirect, using wp_redirect().
 901  *
 902  * Checks whether the $location is using an allowed host, if it has an absolute
 903  * path. A plugin can therefore set or remove allowed host(s) to or from the
 904  * list.
 905  *
 906  * If the host is not allowed, then the redirect is to wp-admin on the siteurl
 907  * instead. This prevents malicious redirects which redirect to another host,
 908  * but only used in a few places.
 909  *
 910  * @since 2.3
 911  * @uses wp_validate_redirect() To validate the redirect is to an allowed host.
 912  *
 913  * @return void Does not return anything
 914  **/
 915 function wp_safe_redirect($location, $status = 302) {
 916
 917         // Need to look at the URL the way it will end up in wp_redirect()
 918         $location = wp_sanitize_redirect($location);
 919
 920         $location = wp_validate_redirect($location, admin_url());
 921
 922         wp_redirect($location, $status);
 923 }
 924 endif;
 925
 926 if ( !function_exists('wp_validate_redirect') ) :
 927 /**
 928  * Validates a URL for use in a redirect.
 929  *
 930  * Checks whether the $location is using an allowed host, if it has an absolute
 931  * path. A plugin can therefore set or remove allowed host(s) to or from the
 932  * list.
 933  *
 934  * If the host is not allowed, then the redirect is to $default supplied
 935  *
 936  * @since 2.8.1
 937  * @uses apply_filters() Calls 'allowed_redirect_hosts' on an array containing
 938  *              WordPress host string and $location host string.
 939  *
 940  * @param string $location The redirect to validate
 941  * @param string $default The value to return if $location is not allowed
 942  * @return string redirect-sanitized URL
 943  **/
 944 function wp_validate_redirect($location, $default = '') {
 945         // browsers will assume 'http' is your protocol, and will obey a redirect to a URL starting with '//'
 946         if ( substr($location, 0, 2) == '//' )
 947                 $location = 'http:' . $location;
 948
 949         // In php 5 parse_url may fail if the URL query part contains http://, bug #38143
 950         $test = ( $cut = strpos($location, '?') ) ? substr( $location, 0, $cut ) : $location;
 951
 952         $lp  = parse_url($test);
 953
 954         // Give up if malformed URL
 955         if ( false === $lp )
 956                 return $default;
 957
 958         // Allow only http and https schemes. No data:, etc.
 959         if ( isset($lp['scheme']) && !('http' == $lp['scheme'] || 'https' == $lp['scheme']) )
 960                 return $default;
 961
 962         // Reject if scheme is set but host is not. This catches urls like https:host.com for which parse_url does not set the host field.
 963         if ( isset($lp['scheme'])  && !isset($lp['host']) )
 964                 return $default;
 965
 966         $wpp = parse_url(home_url());
 967
 968         $allowed_hosts = (array) apply_filters('allowed_redirect_hosts', array($wpp['host']), isset($lp['host']) ? $lp['host'] : '');
 969
 970         if ( isset($lp['host']) && ( !in_array($lp['host'], $allowed_hosts) && $lp['host'] != strtolower($wpp['host'])) )
 971                 $location = $default;
 972
 973         return $location;
 974 }
 975 endif;
 976
 977 if ( ! function_exists('wp_notify_postauthor') ) :
 978 /**
 979  * Notify an author of a comment/trackback/pingback to one of their posts.
 980  *
 981  * @since 1.0.0
 982  *
 983  * @param int $comment_id Comment ID
 984  * @param string $comment_type Optional. The comment type either 'comment' (default), 'trackback', or 'pingback'
 985  * @return bool False if user email does not exist. True on completion.
 986  */
 987 function wp_notify_postauthor( $comment_id, $comment_type = '' ) {
 988         $comment = get_comment( $comment_id );
 989         $post    = get_post( $comment->comment_post_ID );
 990         $author  = get_userdata( $post->post_author );
 991
 992         // The comment was left by the author
 993         if ( $comment->user_id == $post->post_author )
 994                 return false;
 995
 996         // The author moderated a comment on his own post
 997         if ( $post->post_author == get_current_user_id() )
 998                 return false;
 999
1000         // The post author is no longer a member of the blog
1001         if ( ! user_can( $post->post_author, 'read_post', $post->ID ) )
1002                 return false;
1003
1004         // If there's no email to send the comment to
1005         if ( '' == $author->user_email )
1006                 return false;
1007
1008         $comment_author_domain = @gethostbyaddr($comment->comment_author_IP);
1009
1010         // The blogname option is escaped with esc_html on the way into the database in sanitize_option
1011         // we want to reverse this for the plain text arena of emails.
1012         $blogname = wp_specialchars_decode(get_option('blogname'), ENT_QUOTES);
1013
1014         if ( empty( $comment_type ) ) $comment_type = 'comment';
1015
1016         if ('comment' == $comment_type) {
1017                 $notify_message  = sprintf( __( 'New comment on your post "%s"' ), $post->post_title ) . "\r\n";
1018                 /* translators: 1: comment author, 2: author IP, 3: author domain */
1019                 $notify_message .= sprintf( __('Author : %1$s (IP: %2$s , %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
1020                 $notify_message .= sprintf( __('E-mail : %s'), $comment->comment_author_email ) . "\r\n";
1021                 $notify_message .= sprintf( __('URL    : %s'), $comment->comment_author_url ) . "\r\n";
1022                 $notify_message .= sprintf( __('Whois  : http://whois.arin.net/rest/ip/%s'), $comment->comment_author_IP ) . "\r\n";
1023                 $notify_message .= __('Comment: ') . "\r\n" . $comment->comment_content . "\r\n\r\n";
1024                 $notify_message .= __('You can see all comments on this post here: ') . "\r\n";
1025                 /* translators: 1: blog name, 2: post title */
1026                 $subject = sprintf( __('[%1$s] Comment: "%2$s"'), $blogname, $post->post_title );
1027         } elseif ('trackback' == $comment_type) {
1028                 $notify_message  = sprintf( __( 'New trackback on your post "%s"' ), $post->post_title ) . "\r\n";
1029                 /* translators: 1: website name, 2: author IP, 3: author domain */
1030                 $notify_message .= sprintf( __('Website: %1$s (IP: %2$s , %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
1031                 $notify_message .= sprintf( __('URL    : %s'), $comment->comment_author_url ) . "\r\n";
1032                 $notify_message .= __('Excerpt: ') . "\r\n" . $comment->comment_content . "\r\n\r\n";
1033                 $notify_message .= __('You can see all trackbacks on this post here: ') . "\r\n";
1034                 /* translators: 1: blog name, 2: post title */
1035                 $subject = sprintf( __('[%1$s] Trackback: "%2$s"'), $blogname, $post->post_title );
1036         } elseif ('pingback' == $comment_type) {
1037                 $notify_message  = sprintf( __( 'New pingback on your post "%s"' ), $post->post_title ) . "\r\n";
1038                 /* translators: 1: comment author, 2: author IP, 3: author domain */
1039                 $notify_message .= sprintf( __('Website: %1$s (IP: %2$s , %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
1040                 $notify_message .= sprintf( __('URL    : %s'), $comment->comment_author_url ) . "\r\n";
1041                 $notify_message .= __('Excerpt: ') . "\r\n" . sprintf('[...] %s [...]', $comment->comment_content ) . "\r\n\r\n";
1042                 $notify_message .= __('You can see all pingbacks on this post here: ') . "\r\n";
1043                 /* translators: 1: blog name, 2: post title */
1044                 $subject = sprintf( __('[%1$s] Pingback: "%2$s"'), $blogname, $post->post_title );
1045         }
1046         $notify_message .= get_permalink($comment->comment_post_ID) . "#comments\r\n\r\n";
1047         $notify_message .= sprintf( __('Permalink: %s'), get_permalink( $comment->comment_post_ID ) . '#comment-' . $comment_id ) . "\r\n";
1048
1049         if ( user_can( $post->post_author, 'edit_comment', $comment_id ) ) {
1050                 if ( EMPTY_TRASH_DAYS )
1051                         $notify_message .= sprintf( __('Trash it: %s'), admin_url("comment.php?action=trash&c=$comment_id") ) . "\r\n";
1052                 else
1053                         $notify_message .= sprintf( __('Delete it: %s'), admin_url("comment.php?action=delete&c=$comment_id") ) . "\r\n";
1054                 $notify_message .= sprintf( __('Spam it: %s'), admin_url("comment.php?action=spam&c=$comment_id") ) . "\r\n";
1055         }
1056
1057         $wp_email = 'wordpress@' . preg_replace('#^www\.#', '', strtolower($_SERVER['SERVER_NAME']));
1058
1059         if ( '' == $comment->comment_author ) {
1060                 $from = "From: \"$blogname\" <$wp_email>";
1061                 if ( '' != $comment->comment_author_email )
1062                         $reply_to = "Reply-To: $comment->comment_author_email";
1063         } else {
1064                 $from = "From: \"$comment->comment_author\" <$wp_email>";
1065                 if ( '' != $comment->comment_author_email )
1066                         $reply_to = "Reply-To: \"$comment->comment_author_email\" <$comment->comment_author_email>";
1067         }
1068
1069         $message_headers = "$from\n"
1070                 . "Content-Type: text/plain; charset=\"" . get_option('blog_charset') . "\"\n";
1071
1072         if ( isset($reply_to) )
1073                 $message_headers .= $reply_to . "\n";
1074
1075         $notify_message = apply_filters('comment_notification_text', $notify_message, $comment_id);
1076         $subject = apply_filters('comment_notification_subject', $subject, $comment_id);
1077         $message_headers = apply_filters('comment_notification_headers', $message_headers, $comment_id);
1078
1079         @wp_mail( $author->user_email, $subject, $notify_message, $message_headers );
1080
1081         return true;
1082 }
1083 endif;
1084
1085 if ( !function_exists('wp_notify_moderator') ) :
1086 /**
1087  * Notifies the moderator of the blog about a new comment that is awaiting approval.
1088  *
1089  * @since 1.0
1090  * @uses $wpdb
1091  *
1092  * @param int $comment_id Comment ID
1093  * @return bool Always returns true
1094  */
1095 function wp_notify_moderator($comment_id) {
1096         global $wpdb;
1097
1098         if ( 0 == get_option( 'moderation_notify' ) )
1099                 return true;
1100
1101         $comment = get_comment($comment_id);
1102         $post = get_post($comment->comment_post_ID);
1103         $user = get_userdata( $post->post_author );
1104         // Send to the administration and to the post author if the author can modify the comment.
1105         $email_to = array( get_option('admin_email') );
1106         if ( user_can($user->ID, 'edit_comment', $comment_id) && !empty($user->user_email) && ( get_option('admin_email') != $user->user_email) )
1107                 $email_to[] = $user->user_email;
1108
1109         $comment_author_domain = @gethostbyaddr($comment->comment_author_IP);
1110         $comments_waiting = $wpdb->get_var("SELECT count(comment_ID) FROM $wpdb->comments WHERE comment_approved = '0'");
1111
1112         // The blogname option is escaped with esc_html on the way into the database in sanitize_option
1113         // we want to reverse this for the plain text arena of emails.
1114         $blogname = wp_specialchars_decode(get_option('blogname'), ENT_QUOTES);
1115
1116         switch ($comment->comment_type)
1117         {
1118                 case 'trackback':
1119                         $notify_message  = sprintf( __('A new trackback on the post "%s" is waiting for your approval'), $post->post_title ) . "\r\n";
1120                         $notify_message .= get_permalink($comment->comment_post_ID) . "\r\n\r\n";
1121                         $notify_message .= sprintf( __('Website : %1$s (IP: %2$s , %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
1122                         $notify_message .= sprintf( __('URL    : %s'), $comment->comment_author_url ) . "\r\n";
1123                         $notify_message .= __('Trackback excerpt: ') . "\r\n" . $comment->comment_content . "\r\n\r\n";
1124                         break;
1125                 case 'pingback':
1126                         $notify_message  = sprintf( __('A new pingback on the post "%s" is waiting for your approval'), $post->post_title ) . "\r\n";
1127                         $notify_message .= get_permalink($comment->comment_post_ID) . "\r\n\r\n";
1128                         $notify_message .= sprintf( __('Website : %1$s (IP: %2$s , %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
1129                         $notify_message .= sprintf( __('URL    : %s'), $comment->comment_author_url ) . "\r\n";
1130                         $notify_message .= __('Pingback excerpt: ') . "\r\n" . $comment->comment_content . "\r\n\r\n";
1131                         break;
1132                 default: //Comments
1133                         $notify_message  = sprintf( __('A new comment on the post "%s" is waiting for your approval'), $post->post_title ) . "\r\n";
1134                         $notify_message .= get_permalink($comment->comment_post_ID) . "\r\n\r\n";
1135                         $notify_message .= sprintf( __('Author : %1$s (IP: %2$s , %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
1136                         $notify_message .= sprintf( __('E-mail : %s'), $comment->comment_author_email ) . "\r\n";
1137                         $notify_message .= sprintf( __('URL    : %s'), $comment->comment_author_url ) . "\r\n";
1138                         $notify_message .= sprintf( __('Whois  : http://whois.arin.net/rest/ip/%s'), $comment->comment_author_IP ) . "\r\n";
1139                         $notify_message .= __('Comment: ') . "\r\n" . $comment->comment_content . "\r\n\r\n";
1140                         break;
1141         }
1142
1143         $notify_message .= sprintf( __('Approve it: %s'),  admin_url("comment.php?action=approve&c=$comment_id") ) . "\r\n";
1144         if ( EMPTY_TRASH_DAYS )
1145                 $notify_message .= sprintf( __('Trash it: %s'), admin_url("comment.php?action=trash&c=$comment_id") ) . "\r\n";
1146         else
1147                 $notify_message .= sprintf( __('Delete it: %s'), admin_url("comment.php?action=delete&c=$comment_id") ) . "\r\n";
1148         $notify_message .= sprintf( __('Spam it: %s'), admin_url("comment.php?action=spam&c=$comment_id") ) . "\r\n";
1149
1150         $notify_message .= sprintf( _n('Currently %s comment is waiting for approval. Please visit the moderation panel:',
1151                 'Currently %s comments are waiting for approval. Please visit the moderation panel:', $comments_waiting), number_format_i18n($comments_waiting) ) . "\r\n";
1152         $notify_message .= admin_url("edit-comments.php?comment_status=moderated") . "\r\n";
1153
1154         $subject = sprintf( __('[%1$s] Please moderate: "%2$s"'), $blogname, $post->post_title );
1155         $message_headers = '';
1156
1157         $notify_message = apply_filters('comment_moderation_text', $notify_message, $comment_id);
1158         $subject = apply_filters('comment_moderation_subject', $subject, $comment_id);
1159         $message_headers = apply_filters('comment_moderation_headers', $message_headers);
1160
1161         foreach ( $email_to as $email )
1162                 @wp_mail($email, $subject, $notify_message, $message_headers);
1163
1164         return true;
1165 }
1166 endif;
1167
1168 if ( !function_exists('wp_password_change_notification') ) :
1169 /**
1170  * Notify the blog admin of a user changing password, normally via email.
1171  *
1172  * @since 2.7
1173  *
1174  * @param object $user User Object
1175  */
1176 function wp_password_change_notification(&$user) {
1177         // send a copy of password change notification to the admin
1178         // but check to see if it's the admin whose password we're changing, and skip this
1179         if ( $user->user_email != get_option('admin_email') ) {
1180                 $message = sprintf(__('Password Lost and Changed for user: %s'), $user->user_login) . "\r\n";
1181                 // The blogname option is escaped with esc_html on the way into the database in sanitize_option
1182                 // we want to reverse this for the plain text arena of emails.
1183                 $blogname = wp_specialchars_decode(get_option('blogname'), ENT_QUOTES);
1184                 wp_mail(get_option('admin_email'), sprintf(__('[%s] Password Lost/Changed'), $blogname), $message);
1185         }
1186 }
1187 endif;
1188
1189 if ( !function_exists('wp_new_user_notification') ) :
1190 /**
1191  * Notify the blog admin of a new user, normally via email.
1192  *
1193  * @since 2.0
1194  *
1195  * @param int $user_id User ID
1196  * @param string $plaintext_pass Optional. The user's plaintext password
1197  */
1198 function wp_new_user_notification($user_id, $plaintext_pass = '') {
1199         $user = get_userdata( $user_id );
1200
1201         // The blogname option is escaped with esc_html on the way into the database in sanitize_option
1202         // we want to reverse this for the plain text arena of emails.
1203         $blogname = wp_specialchars_decode(get_option('blogname'), ENT_QUOTES);
1204
1205         $message  = sprintf(__('New user registration on your site %s:'), $blogname) . "\r\n\r\n";
1206         $message .= sprintf(__('Username: %s'), $user->user_login) . "\r\n\r\n";
1207         $message .= sprintf(__('E-mail: %s'), $user->user_email) . "\r\n";
1208
1209         @wp_mail(get_option('admin_email'), sprintf(__('[%s] New User Registration'), $blogname), $message);
1210
1211         if ( empty($plaintext_pass) )
1212                 return;
1213
1214         $message  = sprintf(__('Username: %s'), $user->user_login) . "\r\n";
1215         $message .= sprintf(__('Password: %s'), $plaintext_pass) . "\r\n";
1216         $message .= wp_login_url() . "\r\n";
1217
1218         wp_mail($user->user_email, sprintf(__('[%s] Your username and password'), $blogname), $message);
1219
1220 }
1221 endif;
1222
1223 if ( !function_exists('wp_nonce_tick') ) :
1224 /**
1225  * Get the time-dependent variable for nonce creation.
1226  *
1227  * A nonce has a lifespan of two ticks. Nonces in their second tick may be
1228  * updated, e.g. by autosave.
1229  *
1230  * @since 2.5
1231  *
1232  * @return int
1233  */
1234 function wp_nonce_tick() {
1235         $nonce_life = apply_filters( 'nonce_life', DAY_IN_SECONDS );
1236
1237         return ceil(time() / ( $nonce_life / 2 ));
1238 }
1239 endif;
1240
1241 if ( !function_exists('wp_verify_nonce') ) :
1242 /**
1243  * Verify that correct nonce was used with time limit.
1244  *
1245  * The user is given an amount of time to use the token, so therefore, since the
1246  * UID and $action remain the same, the independent variable is the time.
1247  *
1248  * @since 2.0.3
1249  *
1250  * @param string $nonce Nonce that was used in the form to verify
1251  * @param string|int $action Should give context to what is taking place and be the same when nonce was created.
1252  * @return bool Whether the nonce check passed or failed.
1253  */
1254 function wp_verify_nonce($nonce, $action = -1) {
1255         $user = wp_get_current_user();
1256         $uid = (int) $user->ID;
1257         if ( ! $uid )
1258                 $uid = apply_filters( 'nonce_user_logged_out', $uid, $action );
1259
1260         $i = wp_nonce_tick();
1261
1262         // Nonce generated 0-12 hours ago
1263         if ( substr(wp_hash($i . $action . $uid, 'nonce'), -12, 10) === $nonce )
1264                 return 1;
1265         // Nonce generated 12-24 hours ago
1266         if ( substr(wp_hash(($i - 1) . $action . $uid, 'nonce'), -12, 10) === $nonce )
1267                 return 2;
1268         // Invalid nonce
1269         return false;
1270 }
1271 endif;
1272
1273 if ( !function_exists('wp_create_nonce') ) :
1274 /**
1275  * Creates a random, one time use token.
1276  *
1277  * @since 2.0.3
1278  *
1279  * @param string|int $action Scalar value to add context to the nonce.
1280  * @return string The one use form token
1281  */
1282 function wp_create_nonce($action = -1) {
1283         $user = wp_get_current_user();
1284         $uid = (int) $user->ID;
1285         if ( ! $uid )
1286                 $uid = apply_filters( 'nonce_user_logged_out', $uid, $action );
1287
1288         $i = wp_nonce_tick();
1289
1290         return substr(wp_hash($i . $action . $uid, 'nonce'), -12, 10);
1291 }
1292 endif;
1293
1294 if ( !function_exists('wp_salt') ) :
1295 /**
1296  * Get salt to add to hashes.
1297  *
1298  * Salts are created using secret keys. Secret keys are located in two places:
1299  * in the database and in the wp-config.php file. The secret key in the database
1300  * is randomly generated and will be appended to the secret keys in wp-config.php.
1301  *
1302  * The secret keys in wp-config.php should be updated to strong, random keys to maximize
1303  * security. Below is an example of how the secret key constants are defined.
1304  * Do not paste this example directly into wp-config.php. Instead, have a
1305  * {@link https://api.wordpress.org/secret-key/1.1/salt/ secret key created} just
1306  * for you.
1307  *
1308  * <code>
1309  * define('AUTH_KEY',         ' Xakm<o xQy rw4EMsLKM-?!T+,PFF})H4lzcW57AF0U@N@< >M%G4Yt>f`z]MON');
1310  * define('SECURE_AUTH_KEY',  'LzJ}op]mr|6+![P}Ak:uNdJCJZd>(Hx.-Mh#Tz)pCIU#uGEnfFz|f ;;eU%/U^O~');
1311  * define('LOGGED_IN_KEY',    '|i|Ux`9<p-h$aFf(qnT:sDO:D1P^wZ$$/Ra@miTJi9G;ddp_<q}6H1)o|a +&JCM');
1312  * define('NONCE_KEY',        '%:R{[P|,s.KuMltH5}cI;/k<Gx~j!f0I)m_sIyu+&NJZ)-iO>z7X>QYR0Z_XnZ@|');
1313  * define('AUTH_SALT',        'eZyT)-Naw]F8CwA*VaW#q*|.)g@o}||wf~@C-YSt}(dh_r6EbI#A,y|nU2{B#JBW');
1314  * define('SECURE_AUTH_SALT', '!=oLUTXh,QW=H `}`L|9/^4-3 STz},T(w}W<I`.JjPi)<Bmf1v,HpGe}T1:Xt7n');
1315  * define('LOGGED_IN_SALT',   '+XSqHc;@Q*K_b|Z?NC[3H!!EONbh.n<+=uKR:>*c(u`g~EJBf#8u#R{mUEZrozmm');
1316  * define('NONCE_SALT',       'h`GXHhD>SLWVfg1(1(N{;.V!MoE(SfbA_ksP@&`+AycHcAV$+?@3q+rxV{%^VyKT');
1317  * </code>
1318  *
1319  * Salting passwords helps against tools which has stored hashed values of
1320  * common dictionary strings. The added values makes it harder to crack.
1321  *
1322  * @since 2.5
1323  *
1324  * @link https://api.wordpress.org/secret-key/1.1/salt/ Create secrets for wp-config.php
1325  *
1326  * @param string $scheme Authentication scheme (auth, secure_auth, logged_in, nonce)
1327  * @return string Salt value
1328  */
1329 function wp_salt( $scheme = 'auth' ) {
1330         static $cached_salts = array();
1331         if ( isset( $cached_salts[ $scheme ] ) )
1332                 return apply_filters( 'salt', $cached_salts[ $scheme ], $scheme );
1333
1334         static $duplicated_keys;
1335         if ( null === $duplicated_keys ) {
1336                 $duplicated_keys = array( 'put your unique phrase here' => true );
1337                 foreach ( array( 'AUTH', 'SECURE_AUTH', 'LOGGED_IN', 'NONCE', 'SECRET' ) as $first ) {
1338                         foreach ( array( 'KEY', 'SALT' ) as $second ) {
1339                                 if ( ! defined( "{$first}_{$second}" ) )
1340                                         continue;
1341                                 $value = constant( "{$first}_{$second}" );
1342                                 $duplicated_keys[ $value ] = isset( $duplicated_keys[ $value ] );
1343                         }
1344                 }
1345         }
1346
1347         $key = $salt = '';
1348         if ( defined( 'SECRET_KEY' ) && SECRET_KEY && empty( $duplicated_keys[ SECRET_KEY ] ) )
1349                 $key = SECRET_KEY;
1350         if ( 'auth' == $scheme && defined( 'SECRET_SALT' ) && SECRET_SALT && empty( $duplicated_keys[ SECRET_SALT ] ) )
1351                 $salt = SECRET_SALT;
1352
1353         if ( in_array( $scheme, array( 'auth', 'secure_auth', 'logged_in', 'nonce' ) ) ) {
1354                 foreach ( array( 'key', 'salt' ) as $type ) {
1355                         $const = strtoupper( "{$scheme}_{$type}" );
1356                         if ( defined( $const ) && constant( $const ) && empty( $duplicated_keys[ constant( $const ) ] ) ) {
1357                                 $$type = constant( $const );
1358                         } elseif ( ! $$type ) {
1359                                 $$type = get_site_option( "{$scheme}_{$type}" );
1360                                 if ( ! $$type ) {
1361                                         $$type = wp_generate_password( 64, true, true );
1362                                         update_site_option( "{$scheme}_{$type}", $$type );
1363                                 }
1364                         }
1365                 }
1366         } else {
1367                 if ( ! $key ) {
1368                         $key = get_site_option( 'secret_key' );
1369                         if ( ! $key ) {
1370                                 $key = wp_generate_password( 64, true, true );
1371                                 update_site_option( 'secret_key', $key );
1372                         }
1373                 }
1374                 $salt = hash_hmac( 'md5', $scheme, $key );
1375         }
1376
1377         $cached_salts[ $scheme ] = $key . $salt;
1378         return apply_filters( 'salt', $cached_salts[ $scheme ], $scheme );
1379 }
1380 endif;
1381
1382 if ( !function_exists('wp_hash') ) :
1383 /**
1384  * Get hash of given string.
1385  *
1386  * @since 2.0.3
1387  * @uses wp_salt() Get WordPress salt
1388  *
1389  * @param string $data Plain text to hash
1390  * @return string Hash of $data
1391  */
1392 function wp_hash($data, $scheme = 'auth') {
1393         $salt = wp_salt($scheme);
1394
1395         return hash_hmac('md5', $data, $salt);
1396 }
1397 endif;
1398
1399 if ( !function_exists('wp_hash_password') ) :
1400 /**
1401  * Create a hash (encrypt) of a plain text password.
1402  *
1403  * For integration with other applications, this function can be overwritten to
1404  * instead use the other package password checking algorithm.
1405  *
1406  * @since 2.5
1407  * @global object $wp_hasher PHPass object
1408  * @uses PasswordHash::HashPassword
1409  *
1410  * @param string $password Plain text user password to hash
1411  * @return string The hash string of the password
1412  */
1413 function wp_hash_password($password) {
1414         global $wp_hasher;
1415
1416         if ( empty($wp_hasher) ) {
1417                 require_once( ABSPATH . 'wp-includes/class-phpass.php');
1418                 // By default, use the portable hash from phpass
1419                 $wp_hasher = new PasswordHash(8, true);
1420         }
1421
1422         return $wp_hasher->HashPassword($password);
1423 }
1424 endif;
1425
1426 if ( !function_exists('wp_check_password') ) :
1427 /**
1428  * Checks the plaintext password against the encrypted Password.
1429  *
1430  * Maintains compatibility between old version and the new cookie authentication
1431  * protocol using PHPass library. The $hash parameter is the encrypted password
1432  * and the function compares the plain text password when encrypted similarly
1433  * against the already encrypted password to see if they match.
1434  *
1435  * For integration with other applications, this function can be overwritten to
1436  * instead use the other package password checking algorithm.
1437  *
1438  * @since 2.5
1439  * @global object $wp_hasher PHPass object used for checking the password
1440  *      against the $hash + $password
1441  * @uses PasswordHash::CheckPassword
1442  *
1443  * @param string $password Plaintext user's password
1444  * @param string $hash Hash of the user's password to check against.
1445  * @return bool False, if the $password does not match the hashed password
1446  */
1447 function wp_check_password($password, $hash, $user_id = '') {
1448         global $wp_hasher;
1449
1450         // If the hash is still md5...
1451         if ( strlen($hash) <= 32 ) {
1452                 $check = ( $hash == md5($password) );
1453                 if ( $check && $user_id ) {
1454                         // Rehash using new hash.
1455                         wp_set_password($password, $user_id);
1456                         $hash = wp_hash_password($password);
1457                 }
1458
1459                 return apply_filters('check_password', $check, $password, $hash, $user_id);
1460         }
1461
1462         // If the stored hash is longer than an MD5, presume the
1463         // new style phpass portable hash.
1464         if ( empty($wp_hasher) ) {
1465                 require_once( ABSPATH . 'wp-includes/class-phpass.php');
1466                 // By default, use the portable hash from phpass
1467                 $wp_hasher = new PasswordHash(8, true);
1468         }
1469
1470         $check = $wp_hasher->CheckPassword($password, $hash);
1471
1472         return apply_filters('check_password', $check, $password, $hash, $user_id);
1473 }
1474 endif;
1475
1476 if ( !function_exists('wp_generate_password') ) :
1477 /**
1478  * Generates a random password drawn from the defined set of characters.
1479  *
1480  * @since 2.5
1481  *
1482  * @param int $length The length of password to generate
1483  * @param bool $special_chars Whether to include standard special characters. Default true.
1484  * @param bool $extra_special_chars Whether to include other special characters. Used when
1485  *   generating secret keys and salts. Default false.
1486  * @return string The random password
1487  **/
1488 function wp_generate_password( $length = 12, $special_chars = true, $extra_special_chars = false ) {
1489         $chars = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789';
1490         if ( $special_chars )
1491                 $chars .= '!@#$%^&*()';
1492         if ( $extra_special_chars )
1493                 $chars .= '-_ []{}<>~`+=,.;:/?|';
1494
1495         $password = '';
1496         for ( $i = 0; $i < $length; $i++ ) {
1497                 $password .= substr($chars, wp_rand(0, strlen($chars) - 1), 1);
1498         }
1499
1500         // random_password filter was previously in random_password function which was deprecated
1501         return apply_filters('random_password', $password);
1502 }
1503 endif;
1504
1505 if ( !function_exists('wp_rand') ) :
1506 /**
1507  * Generates a random number
1508  *
1509  * @since 2.6.2
1510  *
1511  * @param int $min Lower limit for the generated number
1512  * @param int $max Upper limit for the generated number
1513  * @return int A random number between min and max
1514  */
1515 function wp_rand( $min = 0, $max = 0 ) {
1516         global $rnd_value;
1517
1518         // Reset $rnd_value after 14 uses
1519         // 32(md5) + 40(sha1) + 40(sha1) / 8 = 14 random numbers from $rnd_value
1520         if ( strlen($rnd_value) < 8 ) {
1521                 if ( defined( 'WP_SETUP_CONFIG' ) )
1522                         static $seed = '';
1523                 else
1524                         $seed = get_transient('random_seed');
1525                 $rnd_value = md5( uniqid(microtime() . mt_rand(), true ) . $seed );
1526                 $rnd_value .= sha1($rnd_value);
1527                 $rnd_value .= sha1($rnd_value . $seed);
1528                 $seed = md5($seed . $rnd_value);
1529                 if ( ! defined( 'WP_SETUP_CONFIG' ) )
1530                         set_transient('random_seed', $seed);
1531         }
1532
1533         // Take the first 8 digits for our value
1534         $value = substr($rnd_value, 0, 8);
1535
1536         // Strip the first eight, leaving the remainder for the next call to wp_rand().
1537         $rnd_value = substr($rnd_value, 8);
1538
1539         $value = abs(hexdec($value));
1540
1541         // 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.
1542         $max_random_number = 3000000000 === 2147483647 ? (float) "4294967295" : 4294967295; // 4294967295 = 0xffffffff
1543
1544         // Reduce the value to be within the min - max range
1545         if ( $max != 0 )
1546                 $value = $min + ( $max - $min + 1 ) * $value / ( $max_random_number + 1 );
1547
1548         return abs(intval($value));
1549 }
1550 endif;
1551
1552 if ( !function_exists('wp_set_password') ) :
1553 /**
1554  * Updates the user's password with a new encrypted one.
1555  *
1556  * For integration with other applications, this function can be overwritten to
1557  * instead use the other package password checking algorithm.
1558  *
1559  * @since 2.5
1560  * @uses $wpdb WordPress database object for queries
1561  * @uses wp_hash_password() Used to encrypt the user's password before passing to the database
1562  *
1563  * @param string $password The plaintext new user password
1564  * @param int $user_id User ID
1565  */
1566 function wp_set_password( $password, $user_id ) {
1567         global $wpdb;
1568
1569         $hash = wp_hash_password( trim( $password ) );
1570         $wpdb->update($wpdb->users, array('user_pass' => $hash, 'user_activation_key' => ''), array('ID' => $user_id) );
1571
1572         wp_cache_delete($user_id, 'users');
1573 }
1574 endif;
1575
1576 if ( !function_exists( 'get_avatar' ) ) :
1577 /**
1578  * Retrieve the avatar for a user who provided a user ID or email address.
1579  *
1580  * @since 2.5
1581  * @param int|string|object $id_or_email A user ID,  email address, or comment object
1582  * @param int $size Size of the avatar image
1583  * @param string $default URL to a default image to use if no avatar is available
1584  * @param string $alt Alternative text to use in image tag. Defaults to blank
1585  * @return string <img> tag for the user's avatar
1586 */
1587 function get_avatar( $id_or_email, $size = '96', $default = '', $alt = false ) {
1588         if ( ! get_option('show_avatars') )
1589                 return false;
1590
1591         if ( false === $alt)
1592                 $safe_alt = '';
1593         else
1594                 $safe_alt = esc_attr( $alt );
1595
1596         if ( !is_numeric($size) )
1597                 $size = '96';
1598
1599         $email = '';
1600         if ( is_numeric($id_or_email) ) {
1601                 $id = (int) $id_or_email;
1602                 $user = get_userdata($id);
1603                 if ( $user )
1604                         $email = $user->user_email;
1605         } elseif ( is_object($id_or_email) ) {
1606                 // No avatar for pingbacks or trackbacks
1607                 $allowed_comment_types = apply_filters( 'get_avatar_comment_types', array( 'comment' ) );
1608                 if ( ! empty( $id_or_email->comment_type ) && ! in_array( $id_or_email->comment_type, (array) $allowed_comment_types ) )
1609                         return false;
1610
1611                 if ( !empty($id_or_email->user_id) ) {
1612                         $id = (int) $id_or_email->user_id;
1613                         $user = get_userdata($id);
1614                         if ( $user)
1615                                 $email = $user->user_email;
1616                 } elseif ( !empty($id_or_email->comment_author_email) ) {
1617                         $email = $id_or_email->comment_author_email;
1618                 }
1619         } else {
1620                 $email = $id_or_email;
1621         }
1622
1623         if ( empty($default) ) {
1624                 $avatar_default = get_option('avatar_default');
1625                 if ( empty($avatar_default) )
1626                         $default = 'mystery';
1627                 else
1628                         $default = $avatar_default;
1629         }
1630
1631         if ( !empty($email) )
1632                 $email_hash = md5( strtolower( trim( $email ) ) );
1633
1634         if ( is_ssl() ) {
1635                 $host = 'https://secure.gravatar.com';
1636         } else {
1637                 if ( !empty($email) )
1638                         $host = sprintf( "http://%d.gravatar.com", ( hexdec( $email_hash[0] ) % 2 ) );
1639                 else
1640                         $host = 'http://0.gravatar.com';
1641         }
1642
1643         if ( 'mystery' == $default )
1644                 $default = "$host/avatar/ad516503a11cd5ca435acc9bb6523536?s={$size}"; // ad516503a11cd5ca435acc9bb6523536 == md5('unknown@gravatar.com')
1645         elseif ( 'blank' == $default )
1646                 $default = $email ? 'blank' : includes_url( 'images/blank.gif' );
1647         elseif ( !empty($email) && 'gravatar_default' == $default )
1648                 $default = '';
1649         elseif ( 'gravatar_default' == $default )
1650                 $default = "$host/avatar/?s={$size}";
1651         elseif ( empty($email) )
1652                 $default = "$host/avatar/?d=$default&amp;s={$size}";
1653         elseif ( strpos($default, 'http://') === 0 )
1654                 $default = add_query_arg( 's', $size, $default );
1655
1656         if ( !empty($email) ) {
1657                 $out = "$host/avatar/";
1658                 $out .= $email_hash;
1659                 $out .= '?s='.$size;
1660                 $out .= '&amp;d=' . urlencode( $default );
1661
1662                 $rating = get_option('avatar_rating');
1663                 if ( !empty( $rating ) )
1664                         $out .= "&amp;r={$rating}";
1665
1666                 $avatar = "<img alt='{$safe_alt}' src='{$out}' class='avatar avatar-{$size} photo' height='{$size}' width='{$size}' />";
1667         } else {
1668                 $avatar = "<img alt='{$safe_alt}' src='{$default}' class='avatar avatar-{$size} photo avatar-default' height='{$size}' width='{$size}' />";
1669         }
1670
1671         return apply_filters('get_avatar', $avatar, $id_or_email, $size, $default, $alt);
1672 }
1673 endif;
1674
1675 if ( !function_exists( 'wp_text_diff' ) ) :
1676 /**
1677  * Displays a human readable HTML representation of the difference between two strings.
1678  *
1679  * The Diff is available for getting the changes between versions. The output is
1680  * HTML, so the primary use is for displaying the changes. If the two strings
1681  * are equivalent, then an empty string will be returned.
1682  *
1683  * The arguments supported and can be changed are listed below.
1684  *
1685  * 'title' : Default is an empty string. Titles the diff in a manner compatible
1686  *              with the output.
1687  * 'title_left' : Default is an empty string. Change the HTML to the left of the
1688  *              title.
1689  * 'title_right' : Default is an empty string. Change the HTML to the right of
1690  *              the title.
1691  *
1692  * @since 2.6
1693  * @see wp_parse_args() Used to change defaults to user defined settings.
1694  * @uses Text_Diff
1695  * @uses WP_Text_Diff_Renderer_Table
1696  *
1697  * @param string $left_string "old" (left) version of string
1698  * @param string $right_string "new" (right) version of string
1699  * @param string|array $args Optional. Change 'title', 'title_left', and 'title_right' defaults.
1700  * @return string Empty string if strings are equivalent or HTML with differences.
1701  */
1702 function wp_text_diff( $left_string, $right_string, $args = null ) {
1703         $defaults = array( 'title' => '', 'title_left' => '', 'title_right' => '' );
1704         $args = wp_parse_args( $args, $defaults );
1705
1706         if ( !class_exists( 'WP_Text_Diff_Renderer_Table' ) )
1707                 require( ABSPATH . WPINC . '/wp-diff.php' );
1708
1709         $left_string  = normalize_whitespace($left_string);
1710         $right_string = normalize_whitespace($right_string);
1711
1712         $left_lines  = explode("\n", $left_string);
1713         $right_lines = explode("\n", $right_string);
1714         $text_diff = new Text_Diff($left_lines, $right_lines);
1715         $renderer  = new WP_Text_Diff_Renderer_Table( $args );
1716         $diff = $renderer->render($text_diff);
1717
1718         if ( !$diff )
1719                 return '';
1720
1721         $r  = "<table class='diff'>\n";
1722
1723         if ( ! empty( $args[ 'show_split_view' ] ) ) {
1724                 $r .= "<col class='content diffsplit left' /><col class='content diffsplit middle' /><col class='content diffsplit right' />";
1725         } else {
1726                 $r .= "<col class='content' />";
1727         }
1728
1729         if ( $args['title'] || $args['title_left'] || $args['title_right'] )
1730                 $r .= "<thead>";
1731         if ( $args['title'] )
1732                 $r .= "<tr class='diff-title'><th colspan='4'>$args[title]</th></tr>\n";
1733         if ( $args['title_left'] || $args['title_right'] ) {
1734                 $r .= "<tr class='diff-sub-title'>\n";
1735                 $r .= "\t<td></td><th>$args[title_left]</th>\n";
1736                 $r .= "\t<td></td><th>$args[title_right]</th>\n";
1737                 $r .= "</tr>\n";
1738         }
1739         if ( $args['title'] || $args['title_left'] || $args['title_right'] )
1740                 $r .= "</thead>\n";
1741
1742         $r .= "<tbody>\n$diff\n</tbody>\n";
1743         $r .= "</table>";
1744
1745         return $r;
1746 }
1747 endif;
1748