* @package WordPress
*/
-if ( !function_exists('set_current_user') ) :
-/**
- * Changes the current user by ID or name.
- *
- * Set $id to null and specify a name if you do not know a user's ID.
- *
- * @since 2.0.1
- * @see wp_set_current_user() An alias of wp_set_current_user()
- *
- * @param int|null $id User ID.
- * @param string $name Optional. The user's username
- * @return object returns wp_set_current_user()
- */
-function set_current_user($id, $name = '') {
- return wp_set_current_user($id, $name);
-}
-endif;
-
if ( !function_exists('wp_set_current_user') ) :
/**
* Changes the current user by ID or name.
* actions on users who aren't signed in.
*
* @since 2.0.3
- * @global object $current_user The current user object which holds the user data.
- * @uses do_action() Calls 'set_current_user' hook after setting the current user.
+ * @global WP_User $current_user The current user object which holds the user data.
*
- * @param int $id User ID
+ * @param int $id User ID
* @param string $name User's username
* @return WP_User Current user User object
*/
function wp_set_current_user($id, $name = '') {
global $current_user;
- if ( isset($current_user) && ($id == $current_user->ID) )
+ if ( isset( $current_user ) && ( $current_user instanceof WP_User ) && ( $id == $current_user->ID ) )
return $current_user;
- $current_user = new WP_User($id, $name);
+ $current_user = new WP_User( $id, $name );
- setup_userdata($current_user->ID);
+ setup_userdata( $current_user->ID );
- do_action('set_current_user');
+ /**
+ * Fires after the current user is set.
+ *
+ * @since 2.0.1
+ */
+ do_action( 'set_current_user' );
return $current_user;
}
*
* @since 2.0.3
*
+ * @global WP_User $current_user
+ *
* @return WP_User Current user WP_User object
*/
function wp_get_current_user() {
* Populate global variables with information about the currently logged in user.
*
* Will set the current user, if the current user is not set. The current user
- * will be set to the logged in person. If no user is logged in, then it will
+ * will be set to the logged-in person. If no user is logged-in, then it will
* set the current user to 0, which is invalid and won't have any permissions.
*
* @since 0.71
- * @uses $current_user Checks if the current user is set
- * @uses wp_validate_auth_cookie() Retrieves current logged in user.
*
- * @return bool|null False on XMLRPC Request and invalid auth cookie. Null when current user set
+ * @global WP_User $current_user Checks if the current user is set
+ *
+ * @return false|void False on XML-RPC Request and invalid auth cookie.
*/
function get_currentuserinfo() {
global $current_user;
- if ( defined('XMLRPC_REQUEST') && XMLRPC_REQUEST )
+ if ( ! empty( $current_user ) ) {
+ if ( $current_user instanceof WP_User )
+ return;
+
+ // Upgrade stdClass to WP_User
+ if ( is_object( $current_user ) && isset( $current_user->ID ) ) {
+ $cur_id = $current_user->ID;
+ $current_user = null;
+ wp_set_current_user( $cur_id );
+ return;
+ }
+
+ // $current_user has a junk value. Force to WP_User with ID 0.
+ $current_user = null;
+ wp_set_current_user( 0 );
return false;
+ }
- if ( ! empty($current_user) )
- return;
+ if ( defined('XMLRPC_REQUEST') && XMLRPC_REQUEST ) {
+ wp_set_current_user( 0 );
+ return false;
+ }
- if ( ! $user = wp_validate_auth_cookie() ) {
- if ( empty($_COOKIE[LOGGED_IN_COOKIE]) || !$user = wp_validate_auth_cookie($_COOKIE[LOGGED_IN_COOKIE], 'logged_in') ) {
- wp_set_current_user(0);
- return false;
- }
+ /**
+ * Filter the current user.
+ *
+ * The default filters use this to determine the current user from the
+ * request's cookies, if available.
+ *
+ * Returning a value of false will effectively short-circuit setting
+ * the current user.
+ *
+ * @since 3.9.0
+ *
+ * @param int|bool $user_id User ID if one has been determined, false otherwise.
+ */
+ $user_id = apply_filters( 'determine_current_user', false );
+ if ( ! $user_id ) {
+ wp_set_current_user( 0 );
+ return false;
}
- wp_set_current_user($user);
+ wp_set_current_user( $user_id );
}
endif;
* @since 0.71
*
* @param int $user_id User ID
- * @return bool|object False on failure, User DB row object
+ * @return WP_User|false WP_User object on success, false on failure.
*/
function get_userdata( $user_id ) {
- global $wpdb;
-
- $user_id = absint($user_id);
- if ( $user_id == 0 )
- return false;
-
- $user = wp_cache_get($user_id, 'users');
-
- if ( $user )
- return $user;
-
- if ( !$user = $wpdb->get_row($wpdb->prepare("SELECT * FROM $wpdb->users WHERE ID = %d LIMIT 1", $user_id)) )
- return false;
-
- _fill_user($user);
-
- return $user;
+ return get_user_by( 'id', $user_id );
}
endif;
*
* @since 2.8.0
*
- * @param string $field The field to retrieve the user with. id | slug | email | login
- * @param int|string $value A value for $field. A user ID, slug, email address, or login name.
- * @return bool|object False on failure, User DB row object
+ * @param string $field The field to retrieve the user with. id | slug | email | login
+ * @param int|string $value A value for $field. A user ID, slug, email address, or login name.
+ * @return WP_User|false WP_User object on success, false on failure.
*/
-function get_user_by($field, $value) {
- global $wpdb;
+function get_user_by( $field, $value ) {
+ $userdata = WP_User::get_data_by( $field, $value );
- switch ($field) {
- case 'id':
- return get_userdata($value);
- break;
- case 'slug':
- $user_id = wp_cache_get($value, 'userslugs');
- $field = 'user_nicename';
- break;
- case 'email':
- $user_id = wp_cache_get($value, 'useremail');
- $field = 'user_email';
- break;
- case 'login':
- $value = sanitize_user( $value );
- $user_id = wp_cache_get($value, 'userlogins');
- $field = 'user_login';
- break;
- default:
- return false;
- }
-
- if ( false !== $user_id )
- return get_userdata($user_id);
-
- if ( !$user = $wpdb->get_row( $wpdb->prepare("SELECT * FROM $wpdb->users WHERE $field = %s", $value) ) )
+ if ( !$userdata )
return false;
- _fill_user($user);
+ $user = new WP_User;
+ $user->init( $userdata );
return $user;
}
endif;
-if ( !function_exists('get_userdatabylogin') ) :
+if ( !function_exists('cache_users') ) :
/**
- * Retrieve user info by login name.
+ * Retrieve info for user lists to prevent multiple queries by get_userdata()
*
- * @since 0.71
+ * @since 3.0.0
*
- * @param string $user_login User's username
- * @return bool|object False on failure, User DB row object
- */
-function get_userdatabylogin($user_login) {
- return get_user_by('login', $user_login);
-}
-endif;
-
-if ( !function_exists('get_user_by_email') ) :
-/**
- * Retrieve user info by email.
- *
- * @since 2.5
+ * @global wpdb $wpdb
*
- * @param string $email User's email address
- * @return bool|object False on failure, User DB row object
+ * @param array $user_ids User ID numbers list
*/
-function get_user_by_email($email) {
- return get_user_by('email', $email);
+function cache_users( $user_ids ) {
+ global $wpdb;
+
+ $clean = _get_non_cached_ids( $user_ids, 'users' );
+
+ if ( empty( $clean ) )
+ return;
+
+ $list = implode( ',', $clean );
+
+ $users = $wpdb->get_results( "SELECT * FROM $wpdb->users WHERE ID IN ($list)" );
+
+ $ids = array();
+ foreach ( $users as $user ) {
+ update_user_caches( $user );
+ $ids[] = $user->ID;
+ }
+ update_meta_cache( 'user', $ids );
}
endif;
* be set using the 'wp_mail_charset' filter.
*
* @since 1.2.1
- * @uses apply_filters() Calls 'wp_mail' hook on an array of all of the parameters.
- * @uses apply_filters() Calls 'wp_mail_from' hook to get the from email address.
- * @uses apply_filters() Calls 'wp_mail_from_name' hook to get the from address name.
- * @uses apply_filters() Calls 'wp_mail_content_type' hook to get the email content type.
- * @uses apply_filters() Calls 'wp_mail_charset' hook to get the email charset
- * @uses do_action_ref_array() Calls 'phpmailer_init' hook on the reference to
- * phpmailer object.
- * @uses PHPMailer
- * @
- *
- * @param string $to Email address to send message
- * @param string $subject Email subject
- * @param string $message Message contents
- * @param string|array $headers Optional. Additional headers.
+ *
+ * @global PHPMailer $phpmailer
+ *
+ * @param string|array $to Array or comma-separated list of email addresses to send message.
+ * @param string $subject Email subject
+ * @param string $message Message contents
+ * @param string|array $headers Optional. Additional headers.
* @param string|array $attachments Optional. Files to attach.
* @return bool Whether the email contents were sent successfully.
*/
function wp_mail( $to, $subject, $message, $headers = '', $attachments = array() ) {
// Compact the input, apply the filters, and extract them back out
- extract( apply_filters( 'wp_mail', compact( 'to', 'subject', 'message', 'headers', 'attachments' ) ) );
- if ( !is_array($attachments) )
- $attachments = explode( "\n", $attachments );
+ /**
+ * Filter the wp_mail() arguments.
+ *
+ * @since 2.2.0
+ *
+ * @param array $args A compacted array of wp_mail() arguments, including the "to" email,
+ * subject, message, headers, and attachments values.
+ */
+ $atts = apply_filters( 'wp_mail', compact( 'to', 'subject', 'message', 'headers', 'attachments' ) );
+
+ if ( isset( $atts['to'] ) ) {
+ $to = $atts['to'];
+ }
+
+ if ( isset( $atts['subject'] ) ) {
+ $subject = $atts['subject'];
+ }
+
+ if ( isset( $atts['message'] ) ) {
+ $message = $atts['message'];
+ }
+
+ if ( isset( $atts['headers'] ) ) {
+ $headers = $atts['headers'];
+ }
+
+ if ( isset( $atts['attachments'] ) ) {
+ $attachments = $atts['attachments'];
+ }
+ if ( ! is_array( $attachments ) ) {
+ $attachments = explode( "\n", str_replace( "\r\n", "\n", $attachments ) );
+ }
global $phpmailer;
// (Re)create it, if it's gone missing
- if ( !is_object( $phpmailer ) || !is_a( $phpmailer, 'PHPMailer' ) ) {
+ if ( ! ( $phpmailer instanceof PHPMailer ) ) {
require_once ABSPATH . WPINC . '/class-phpmailer.php';
require_once ABSPATH . WPINC . '/class-smtp.php';
- $phpmailer = new PHPMailer();
+ $phpmailer = new PHPMailer( true );
}
// Headers
if ( !is_array( $headers ) ) {
// Explode the headers out, so this function can take both
// string headers and an array of headers.
- $tempheaders = (array) explode( "\n", $headers );
+ $tempheaders = explode( "\n", str_replace( "\r\n", "\n", $headers ) );
} else {
$tempheaders = $headers;
}
$headers = array();
+ $cc = array();
+ $bcc = array();
// If it's actually got contents
if ( !empty( $tempheaders ) ) {
list( $name, $content ) = explode( ':', trim( $header ), 2 );
// Cleanup crew
- $name = trim( $name );
+ $name = trim( $name );
$content = trim( $content );
- // Mainly for legacy -- process a From: header if it's there
- if ( 'from' == strtolower($name) ) {
- if ( strpos($content, '<' ) !== false ) {
- // So... making my life hard again?
- $from_name = substr( $content, 0, strpos( $content, '<' ) - 1 );
- $from_name = str_replace( '"', '', $from_name );
- $from_name = trim( $from_name );
-
- $from_email = substr( $content, strpos( $content, '<' ) + 1 );
- $from_email = str_replace( '>', '', $from_email );
- $from_email = trim( $from_email );
- } else {
- $from_email = trim( $content );
- }
- } elseif ( 'content-type' == strtolower($name) ) {
- if ( strpos( $content,';' ) !== false ) {
- list( $type, $charset ) = explode( ';', $content );
- $content_type = trim( $type );
- if ( false !== stripos( $charset, 'charset=' ) ) {
- $charset = trim( str_replace( array( 'charset=', '"' ), '', $charset ) );
- } elseif ( false !== stripos( $charset, 'boundary=' ) ) {
- $boundary = trim( str_replace( array( 'BOUNDARY=', 'boundary=', '"' ), '', $charset ) );
- $charset = '';
+ switch ( strtolower( $name ) ) {
+ // Mainly for legacy -- process a From: header if it's there
+ case 'from':
+ $bracket_pos = strpos( $content, '<' );
+ if ( $bracket_pos !== false ) {
+ // Text before the bracketed email is the "From" name.
+ if ( $bracket_pos > 0 ) {
+ $from_name = substr( $content, 0, $bracket_pos - 1 );
+ $from_name = str_replace( '"', '', $from_name );
+ $from_name = trim( $from_name );
+ }
+
+ $from_email = substr( $content, $bracket_pos + 1 );
+ $from_email = str_replace( '>', '', $from_email );
+ $from_email = trim( $from_email );
+
+ // Avoid setting an empty $from_email.
+ } elseif ( '' !== trim( $content ) ) {
+ $from_email = trim( $content );
}
- } else {
- $content_type = trim( $content );
- }
- } elseif ( 'cc' == strtolower($name) ) {
- $cc = explode(",", $content);
- } elseif ( 'bcc' == strtolower($name) ) {
- $bcc = explode(",", $content);
- } else {
- // Add it to our grand headers array
- $headers[trim( $name )] = trim( $content );
+ break;
+ case 'content-type':
+ if ( strpos( $content, ';' ) !== false ) {
+ list( $type, $charset_content ) = explode( ';', $content );
+ $content_type = trim( $type );
+ if ( false !== stripos( $charset_content, 'charset=' ) ) {
+ $charset = trim( str_replace( array( 'charset=', '"' ), '', $charset_content ) );
+ } elseif ( false !== stripos( $charset_content, 'boundary=' ) ) {
+ $boundary = trim( str_replace( array( 'BOUNDARY=', 'boundary=', '"' ), '', $charset_content ) );
+ $charset = '';
+ }
+
+ // Avoid setting an empty $content_type.
+ } elseif ( '' !== trim( $content ) ) {
+ $content_type = trim( $content );
+ }
+ break;
+ case 'cc':
+ $cc = array_merge( (array) $cc, explode( ',', $content ) );
+ break;
+ case 'bcc':
+ $bcc = array_merge( (array) $bcc, explode( ',', $content ) );
+ break;
+ default:
+ // Add it to our grand headers array
+ $headers[trim( $name )] = trim( $content );
+ break;
}
}
}
}
// Empty out the values that may be set
- $phpmailer->ClearAddresses();
$phpmailer->ClearAllRecipients();
$phpmailer->ClearAttachments();
- $phpmailer->ClearBCCs();
- $phpmailer->ClearCCs();
$phpmailer->ClearCustomHeaders();
$phpmailer->ClearReplyTos();
// From email and name
// If we don't have a name from the input headers
- if ( !isset( $from_name ) ) {
+ if ( !isset( $from_name ) )
$from_name = 'WordPress';
- }
/* If we don't have an email from the input headers default to wordpress@$sitename
* Some hosts will block outgoing mail from this address if it doesn't exist but
* there's no easy alternative. Defaulting to admin_email might appear to be another
* option but some hosts may refuse to relay mail from an unknown domain. See
- * http://trac.wordpress.org/ticket/5007.
+ * https://core.trac.wordpress.org/ticket/5007.
*/
if ( !isset( $from_email ) ) {
$from_email = 'wordpress@' . $sitename;
}
- // Plugin authors can override the potentially troublesome default
+ /**
+ * Filter the email address to send from.
+ *
+ * @since 2.2.0
+ *
+ * @param string $from_email Email address to send from.
+ */
$phpmailer->From = apply_filters( 'wp_mail_from', $from_email );
+
+ /**
+ * Filter the name to associate with the "from" email address.
+ *
+ * @since 2.3.0
+ *
+ * @param string $from_name Name associated with the "from" email address.
+ */
$phpmailer->FromName = apply_filters( 'wp_mail_from_name', $from_name );
- // Set destination address
- $phpmailer->AddAddress( $to );
+ // Set destination addresses
+ if ( !is_array( $to ) )
+ $to = explode( ',', $to );
+
+ foreach ( (array) $to as $recipient ) {
+ try {
+ // Break $recipient into name and address parts if in the format "Foo <bar@baz.com>"
+ $recipient_name = '';
+ if ( preg_match( '/(.*)<(.+)>/', $recipient, $matches ) ) {
+ if ( count( $matches ) == 3 ) {
+ $recipient_name = $matches[1];
+ $recipient = $matches[2];
+ }
+ }
+ $phpmailer->AddAddress( $recipient, $recipient_name);
+ } catch ( phpmailerException $e ) {
+ continue;
+ }
+ }
// Set mail's subject and body
$phpmailer->Subject = $subject;
- $phpmailer->Body = $message;
+ $phpmailer->Body = $message;
// Add any CC and BCC recipients
- if ( !empty($cc) ) {
+ if ( !empty( $cc ) ) {
foreach ( (array) $cc as $recipient ) {
- $phpmailer->AddCc( trim($recipient) );
+ try {
+ // Break $recipient into name and address parts if in the format "Foo <bar@baz.com>"
+ $recipient_name = '';
+ if ( preg_match( '/(.*)<(.+)>/', $recipient, $matches ) ) {
+ if ( count( $matches ) == 3 ) {
+ $recipient_name = $matches[1];
+ $recipient = $matches[2];
+ }
+ }
+ $phpmailer->AddCc( $recipient, $recipient_name );
+ } catch ( phpmailerException $e ) {
+ continue;
+ }
}
}
- if ( !empty($bcc) ) {
+
+ if ( !empty( $bcc ) ) {
foreach ( (array) $bcc as $recipient) {
- $phpmailer->AddBcc( trim($recipient) );
+ try {
+ // Break $recipient into name and address parts if in the format "Foo <bar@baz.com>"
+ $recipient_name = '';
+ if ( preg_match( '/(.*)<(.+)>/', $recipient, $matches ) ) {
+ if ( count( $matches ) == 3 ) {
+ $recipient_name = $matches[1];
+ $recipient = $matches[2];
+ }
+ }
+ $phpmailer->AddBcc( $recipient, $recipient_name );
+ } catch ( phpmailerException $e ) {
+ continue;
+ }
}
}
// Set Content-Type and charset
// If we don't have a content-type from the input headers
- if ( !isset( $content_type ) ) {
+ if ( !isset( $content_type ) )
$content_type = 'text/plain';
- }
+ /**
+ * Filter the wp_mail() content type.
+ *
+ * @since 2.3.0
+ *
+ * @param string $content_type Default wp_mail() content type.
+ */
$content_type = apply_filters( 'wp_mail_content_type', $content_type );
$phpmailer->ContentType = $content_type;
- // Set whether it's plaintext or not, depending on $content_type
- if ( $content_type == 'text/html' ) {
+ // Set whether it's plaintext, depending on $content_type
+ if ( 'text/html' == $content_type )
$phpmailer->IsHTML( true );
- }
// If we don't have a charset from the input headers
- if ( !isset( $charset ) ) {
+ if ( !isset( $charset ) )
$charset = get_bloginfo( 'charset' );
- }
// Set the content-type and charset
+
+ /**
+ * Filter the default wp_mail() charset.
+ *
+ * @since 2.3.0
+ *
+ * @param string $charset Default email charset.
+ */
$phpmailer->CharSet = apply_filters( 'wp_mail_charset', $charset );
// Set custom headers
foreach( (array) $headers as $name => $content ) {
$phpmailer->AddCustomHeader( sprintf( '%1$s: %2$s', $name, $content ) );
}
- if ( false !== stripos( $content_type, 'multipart' ) && ! empty($boundary) ) {
+
+ if ( false !== stripos( $content_type, 'multipart' ) && ! empty($boundary) )
$phpmailer->AddCustomHeader( sprintf( "Content-Type: %s;\n\t boundary=\"%s\"", $content_type, $boundary ) );
- }
}
if ( !empty( $attachments ) ) {
foreach ( $attachments as $attachment ) {
- $phpmailer->AddAttachment($attachment);
+ try {
+ $phpmailer->AddAttachment($attachment);
+ } catch ( phpmailerException $e ) {
+ continue;
+ }
}
}
+ /**
+ * Fires after PHPMailer is initialized.
+ *
+ * @since 2.2.0
+ *
+ * @param PHPMailer &$phpmailer The PHPMailer instance, passed by reference.
+ */
do_action_ref_array( 'phpmailer_init', array( &$phpmailer ) );
// Send!
- $result = @$phpmailer->Send();
-
- return $result;
+ try {
+ return $phpmailer->Send();
+ } catch ( phpmailerException $e ) {
+ return false;
+ }
}
endif;
*
* @param string $username User's username
* @param string $password User's password
- * @return WP_Error|WP_User WP_User object if login successful, otherwise WP_Error object.
+ * @return WP_User|WP_Error WP_User object if login successful, otherwise WP_Error object.
*/
function wp_authenticate($username, $password) {
$username = sanitize_user($username);
$password = trim($password);
- $user = apply_filters('authenticate', null, $username, $password);
+ /**
+ * Filter the user to authenticate.
+ *
+ * If a non-null value is passed, the filter will effectively short-circuit
+ * authentication, returning an error instead.
+ *
+ * @since 2.8.0
+ *
+ * @param null|WP_User $user User to authenticate.
+ * @param string $username User login.
+ * @param string $password User password
+ */
+ $user = apply_filters( 'authenticate', null, $username, $password );
if ( $user == null ) {
// TODO what should the error message be? (Or would these even happen?)
$ignore_codes = array('empty_username', 'empty_password');
if (is_wp_error($user) && !in_array($user->get_error_code(), $ignore_codes) ) {
- do_action('wp_login_failed', $username);
+ /**
+ * Fires after a user login has failed.
+ *
+ * @since 2.5.0
+ *
+ * @param string $username User login.
+ */
+ do_action( 'wp_login_failed', $username );
}
return $user;
* @since 2.5.0
*/
function wp_logout() {
+ wp_destroy_current_session();
wp_clear_auth_cookie();
- do_action('wp_logout');
+
+ /**
+ * Fires after a user is logged-out.
+ *
+ * @since 1.5.0
+ */
+ do_action( 'wp_logout' );
}
endif;
* Makes sure the cookie is not expired. Verifies the hash in cookie is what is
* should be and compares the two.
*
- * @since 2.5
+ * @since 2.5.0
+ *
+ * @global int $login_grace_period
*
* @param string $cookie Optional. If used, will validate contents instead of cookie's
* @param string $scheme Optional. The cookie scheme to use: auth, secure_auth, or logged_in
- * @return bool|int False if invalid cookie, User ID if valid.
+ * @return false|int False if invalid cookie, User ID if valid.
*/
function wp_validate_auth_cookie($cookie = '', $scheme = '') {
if ( ! $cookie_elements = wp_parse_auth_cookie($cookie, $scheme) ) {
- do_action('auth_cookie_malformed', $cookie, $scheme);
+ /**
+ * Fires if an authentication cookie is malformed.
+ *
+ * @since 2.7.0
+ *
+ * @param string $cookie Malformed auth cookie.
+ * @param string $scheme Authentication scheme. Values include 'auth', 'secure_auth',
+ * or 'logged_in'.
+ */
+ do_action( 'auth_cookie_malformed', $cookie, $scheme );
return false;
}
- extract($cookie_elements, EXTR_OVERWRITE);
-
- $expired = $expiration;
+ $scheme = $cookie_elements['scheme'];
+ $username = $cookie_elements['username'];
+ $hmac = $cookie_elements['hmac'];
+ $token = $cookie_elements['token'];
+ $expired = $expiration = $cookie_elements['expiration'];
// Allow a grace period for POST and AJAX requests
- if ( defined('DOING_AJAX') || 'POST' == $_SERVER['REQUEST_METHOD'] )
- $expired += 3600;
+ if ( defined('DOING_AJAX') || 'POST' == $_SERVER['REQUEST_METHOD'] ) {
+ $expired += HOUR_IN_SECONDS;
+ }
// Quick check to see if an honest cookie has expired
if ( $expired < time() ) {
- do_action('auth_cookie_expired', $cookie_elements);
+ /**
+ * Fires once an authentication cookie has expired.
+ *
+ * @since 2.7.0
+ *
+ * @param array $cookie_elements An array of data for the authentication cookie.
+ */
+ do_action( 'auth_cookie_expired', $cookie_elements );
return false;
}
- $user = get_userdatabylogin($username);
+ $user = get_user_by('login', $username);
if ( ! $user ) {
- do_action('auth_cookie_bad_username', $cookie_elements);
+ /**
+ * Fires if a bad username is entered in the user authentication process.
+ *
+ * @since 2.7.0
+ *
+ * @param array $cookie_elements An array of data for the authentication cookie.
+ */
+ do_action( 'auth_cookie_bad_username', $cookie_elements );
return false;
}
$pass_frag = substr($user->user_pass, 8, 4);
- $key = wp_hash($username . $pass_frag . '|' . $expiration, $scheme);
- $hash = hash_hmac('md5', $username . '|' . $expiration, $key);
+ $key = wp_hash( $username . '|' . $pass_frag . '|' . $expiration . '|' . $token, $scheme );
+
+ // If ext/hash is not present, compat.php's hash_hmac() does not support sha256.
+ $algo = function_exists( 'hash' ) ? 'sha256' : 'sha1';
+ $hash = hash_hmac( $algo, $username . '|' . $expiration . '|' . $token, $key );
+
+ if ( ! hash_equals( $hash, $hmac ) ) {
+ /**
+ * Fires if a bad authentication cookie hash is encountered.
+ *
+ * @since 2.7.0
+ *
+ * @param array $cookie_elements An array of data for the authentication cookie.
+ */
+ do_action( 'auth_cookie_bad_hash', $cookie_elements );
+ return false;
+ }
- if ( $hmac != $hash ) {
- do_action('auth_cookie_bad_hash', $cookie_elements);
+ $manager = WP_Session_Tokens::get_instance( $user->ID );
+ if ( ! $manager->verify( $token ) ) {
+ do_action( 'auth_cookie_bad_session_token', $cookie_elements );
return false;
}
- do_action('auth_cookie_valid', $cookie_elements, $user);
+ // AJAX/POST grace period set above
+ if ( $expiration < time() ) {
+ $GLOBALS['login_grace_period'] = 1;
+ }
+
+ /**
+ * Fires once an authentication cookie has been validated.
+ *
+ * @since 2.7.0
+ *
+ * @param array $cookie_elements An array of data for the authentication cookie.
+ * @param WP_User $user User object.
+ */
+ do_action( 'auth_cookie_valid', $cookie_elements, $user );
return $user->ID;
}
/**
* Generate authentication cookie contents.
*
- * @since 2.5
- * @uses apply_filters() Calls 'auth_cookie' hook on $cookie contents, User ID
- * and expiration of cookie.
+ * @since 2.5.0
*
- * @param int $user_id User ID
- * @param int $expiration Cookie expiration in seconds
- * @param string $scheme Optional. The cookie scheme to use: auth, secure_auth, or logged_in
- * @return string Authentication cookie contents
+ * @param int $user_id User ID
+ * @param int $expiration Cookie expiration in seconds
+ * @param string $scheme Optional. The cookie scheme to use: auth, secure_auth, or logged_in
+ * @param string $token User's session token to use for this cookie
+ * @return string Authentication cookie contents. Empty string if user does not exist.
*/
-function wp_generate_auth_cookie($user_id, $expiration, $scheme = 'auth') {
+function wp_generate_auth_cookie( $user_id, $expiration, $scheme = 'auth', $token = '' ) {
$user = get_userdata($user_id);
+ if ( ! $user ) {
+ return '';
+ }
+
+ if ( ! $token ) {
+ $manager = WP_Session_Tokens::get_instance( $user_id );
+ $token = $manager->create( $expiration );
+ }
$pass_frag = substr($user->user_pass, 8, 4);
- $key = wp_hash($user->user_login . $pass_frag . '|' . $expiration, $scheme);
- $hash = hash_hmac('md5', $user->user_login . '|' . $expiration, $key);
+ $key = wp_hash( $user->user_login . '|' . $pass_frag . '|' . $expiration . '|' . $token, $scheme );
- $cookie = $user->user_login . '|' . $expiration . '|' . $hash;
+ // If ext/hash is not present, compat.php's hash_hmac() does not support sha256.
+ $algo = function_exists( 'hash' ) ? 'sha256' : 'sha1';
+ $hash = hash_hmac( $algo, $user->user_login . '|' . $expiration . '|' . $token, $key );
- return apply_filters('auth_cookie', $cookie, $user_id, $expiration, $scheme);
+ $cookie = $user->user_login . '|' . $expiration . '|' . $token . '|' . $hash;
+
+ /**
+ * Filter the authentication cookie.
+ *
+ * @since 2.5.0
+ *
+ * @param string $cookie Authentication cookie.
+ * @param int $user_id User ID.
+ * @param int $expiration Authentication cookie expiration in seconds.
+ * @param string $scheme Cookie scheme used. Accepts 'auth', 'secure_auth', or 'logged_in'.
+ * @param string $token User's session token used.
+ */
+ return apply_filters( 'auth_cookie', $cookie, $user_id, $expiration, $scheme, $token );
}
endif;
/**
* Parse a cookie into its components
*
- * @since 2.7
+ * @since 2.7.0
*
* @param string $cookie
* @param string $scheme Optional. The cookie scheme to use: auth, secure_auth, or logged_in
- * @return array Authentication cookie components
+ * @return array|false Authentication cookie components
*/
function wp_parse_auth_cookie($cookie = '', $scheme = '') {
if ( empty($cookie) ) {
}
$cookie_elements = explode('|', $cookie);
- if ( count($cookie_elements) != 3 )
+ if ( count( $cookie_elements ) !== 4 ) {
return false;
+ }
- list($username, $expiration, $hmac) = $cookie_elements;
+ list( $username, $expiration, $token, $hmac ) = $cookie_elements;
- return compact('username', 'expiration', 'hmac', 'scheme');
+ return compact( 'username', 'expiration', 'token', 'hmac', 'scheme' );
}
endif;
if ( !function_exists('wp_set_auth_cookie') ) :
/**
- * Sets the authentication cookies based User ID.
+ * Sets the authentication cookies based on user ID.
*
* The $remember parameter increases the time that the cookie will be kept. The
* default the cookie is kept without remembering is two days. When $remember is
* set, the cookies will be kept for 14 days or two weeks.
*
- * @since 2.5
+ * @since 2.5.0
+ * @since 4.3.0 Added the `$token` parameter.
*
- * @param int $user_id User ID
- * @param bool $remember Whether to remember the user or not
+ * @param int $user_id User ID
+ * @param bool $remember Whether to remember the user
+ * @param mixed $secure Whether the admin cookies should only be sent over HTTPS.
+ * Default is_ssl().
+ * @param string $token Optional. User's session token to use for this cookie.
*/
-function wp_set_auth_cookie($user_id, $remember = false, $secure = '') {
+function wp_set_auth_cookie( $user_id, $remember = false, $secure = '', $token = '' ) {
if ( $remember ) {
- $expiration = $expire = time() + apply_filters('auth_cookie_expiration', 1209600, $user_id, $remember);
+ /**
+ * Filter the duration of the authentication cookie expiration period.
+ *
+ * @since 2.8.0
+ *
+ * @param int $length Duration of the expiration period in seconds.
+ * @param int $user_id User ID.
+ * @param bool $remember Whether to remember the user login. Default false.
+ */
+ $expiration = time() + apply_filters( 'auth_cookie_expiration', 14 * DAY_IN_SECONDS, $user_id, $remember );
+
+ /*
+ * Ensure the browser will continue to send the cookie after the expiration time is reached.
+ * Needed for the login grace period in wp_validate_auth_cookie().
+ */
+ $expire = $expiration + ( 12 * HOUR_IN_SECONDS );
} else {
- $expiration = time() + apply_filters('auth_cookie_expiration', 172800, $user_id, $remember);
+ /** This filter is documented in wp-includes/pluggable.php */
+ $expiration = time() + apply_filters( 'auth_cookie_expiration', 2 * DAY_IN_SECONDS, $user_id, $remember );
$expire = 0;
}
- if ( '' === $secure )
- $secure = is_ssl() ? true : false;
+ if ( '' === $secure ) {
+ $secure = is_ssl();
+ }
+
+ // Frontend cookie is secure when the auth cookie is secure and the site's home URL is forced HTTPS.
+ $secure_logged_in_cookie = $secure && 'https' === parse_url( get_option( 'home' ), PHP_URL_SCHEME );
+
+ /**
+ * Filter whether the connection is secure.
+ *
+ * @since 3.1.0
+ *
+ * @param bool $secure Whether the connection is secure.
+ * @param int $user_id User ID.
+ */
+ $secure = apply_filters( 'secure_auth_cookie', $secure, $user_id );
+
+ /**
+ * Filter whether to use a secure cookie when logged-in.
+ *
+ * @since 3.1.0
+ *
+ * @param bool $secure_logged_in_cookie Whether to use a secure cookie when logged-in.
+ * @param int $user_id User ID.
+ * @param bool $secure Whether the connection is secure.
+ */
+ $secure_logged_in_cookie = apply_filters( 'secure_logged_in_cookie', $secure_logged_in_cookie, $user_id, $secure );
if ( $secure ) {
$auth_cookie_name = SECURE_AUTH_COOKIE;
$scheme = 'auth';
}
- $auth_cookie = wp_generate_auth_cookie($user_id, $expiration, $scheme);
- $logged_in_cookie = wp_generate_auth_cookie($user_id, $expiration, 'logged_in');
+ if ( '' === $token ) {
+ $manager = WP_Session_Tokens::get_instance( $user_id );
+ $token = $manager->create( $expiration );
+ }
- do_action('set_auth_cookie', $auth_cookie, $expire, $expiration, $user_id, $scheme);
- do_action('set_logged_in_cookie', $logged_in_cookie, $expire, $expiration, $user_id, 'logged_in');
+ $auth_cookie = wp_generate_auth_cookie( $user_id, $expiration, $scheme, $token );
+ $logged_in_cookie = wp_generate_auth_cookie( $user_id, $expiration, 'logged_in', $token );
+
+ /**
+ * Fires immediately before the authentication cookie is set.
+ *
+ * @since 2.5.0
+ *
+ * @param string $auth_cookie Authentication cookie.
+ * @param int $expire Login grace period in seconds. Default 43,200 seconds, or 12 hours.
+ * @param int $expiration Duration in seconds the authentication cookie should be valid.
+ * Default 1,209,600 seconds, or 14 days.
+ * @param int $user_id User ID.
+ * @param string $scheme Authentication scheme. Values include 'auth', 'secure_auth', or 'logged_in'.
+ */
+ do_action( 'set_auth_cookie', $auth_cookie, $expire, $expiration, $user_id, $scheme );
+
+ /**
+ * Fires immediately before the secure authentication cookie is set.
+ *
+ * @since 2.6.0
+ *
+ * @param string $logged_in_cookie The logged-in cookie.
+ * @param int $expire Login grace period in seconds. Default 43,200 seconds, or 12 hours.
+ * @param int $expiration Duration in seconds the authentication cookie should be valid.
+ * Default 1,209,600 seconds, or 14 days.
+ * @param int $user_id User ID.
+ * @param string $scheme Authentication scheme. Default 'logged_in'.
+ */
+ do_action( 'set_logged_in_cookie', $logged_in_cookie, $expire, $expiration, $user_id, 'logged_in' );
- // Set httponly if the php version is >= 5.2.0
- if ( version_compare(phpversion(), '5.2.0', 'ge') ) {
- setcookie($auth_cookie_name, $auth_cookie, $expire, PLUGINS_COOKIE_PATH, COOKIE_DOMAIN, $secure, true);
- setcookie($auth_cookie_name, $auth_cookie, $expire, ADMIN_COOKIE_PATH, COOKIE_DOMAIN, $secure, true);
- setcookie(LOGGED_IN_COOKIE, $logged_in_cookie, $expire, COOKIEPATH, COOKIE_DOMAIN, false, true);
- if ( COOKIEPATH != SITECOOKIEPATH )
- setcookie(LOGGED_IN_COOKIE, $logged_in_cookie, $expire, SITECOOKIEPATH, COOKIE_DOMAIN, false, true);
- } else {
- $cookie_domain = COOKIE_DOMAIN;
- if ( !empty($cookie_domain) )
- $cookie_domain .= '; HttpOnly';
- setcookie($auth_cookie_name, $auth_cookie, $expire, PLUGINS_COOKIE_PATH, $cookie_domain, $secure);
- setcookie($auth_cookie_name, $auth_cookie, $expire, ADMIN_COOKIE_PATH, $cookie_domain, $secure);
- setcookie(LOGGED_IN_COOKIE, $logged_in_cookie, $expire, COOKIEPATH, $cookie_domain);
- if ( COOKIEPATH != SITECOOKIEPATH )
- setcookie(LOGGED_IN_COOKIE, $logged_in_cookie, $expire, SITECOOKIEPATH, $cookie_domain);
- }
+ setcookie($auth_cookie_name, $auth_cookie, $expire, PLUGINS_COOKIE_PATH, COOKIE_DOMAIN, $secure, true);
+ setcookie($auth_cookie_name, $auth_cookie, $expire, ADMIN_COOKIE_PATH, COOKIE_DOMAIN, $secure, true);
+ setcookie(LOGGED_IN_COOKIE, $logged_in_cookie, $expire, COOKIEPATH, COOKIE_DOMAIN, $secure_logged_in_cookie, true);
+ if ( COOKIEPATH != SITECOOKIEPATH )
+ setcookie(LOGGED_IN_COOKIE, $logged_in_cookie, $expire, SITECOOKIEPATH, COOKIE_DOMAIN, $secure_logged_in_cookie, true);
}
endif;
/**
* Removes all of the cookies associated with authentication.
*
- * @since 2.5
+ * @since 2.5.0
*/
function wp_clear_auth_cookie() {
- do_action('clear_auth_cookie');
+ /**
+ * Fires just before the authentication cookies are cleared.
+ *
+ * @since 2.7.0
+ */
+ do_action( 'clear_auth_cookie' );
- setcookie(AUTH_COOKIE, ' ', time() - 31536000, ADMIN_COOKIE_PATH, COOKIE_DOMAIN);
- setcookie(SECURE_AUTH_COOKIE, ' ', time() - 31536000, ADMIN_COOKIE_PATH, COOKIE_DOMAIN);
- setcookie(AUTH_COOKIE, ' ', time() - 31536000, PLUGINS_COOKIE_PATH, COOKIE_DOMAIN);
- setcookie(SECURE_AUTH_COOKIE, ' ', time() - 31536000, PLUGINS_COOKIE_PATH, COOKIE_DOMAIN);
- setcookie(LOGGED_IN_COOKIE, ' ', time() - 31536000, COOKIEPATH, COOKIE_DOMAIN);
- setcookie(LOGGED_IN_COOKIE, ' ', time() - 31536000, SITECOOKIEPATH, COOKIE_DOMAIN);
+ setcookie( AUTH_COOKIE, ' ', time() - YEAR_IN_SECONDS, ADMIN_COOKIE_PATH, COOKIE_DOMAIN );
+ setcookie( SECURE_AUTH_COOKIE, ' ', time() - YEAR_IN_SECONDS, ADMIN_COOKIE_PATH, COOKIE_DOMAIN );
+ setcookie( AUTH_COOKIE, ' ', time() - YEAR_IN_SECONDS, PLUGINS_COOKIE_PATH, COOKIE_DOMAIN );
+ setcookie( SECURE_AUTH_COOKIE, ' ', time() - YEAR_IN_SECONDS, PLUGINS_COOKIE_PATH, COOKIE_DOMAIN );
+ setcookie( LOGGED_IN_COOKIE, ' ', time() - YEAR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN );
+ setcookie( LOGGED_IN_COOKIE, ' ', time() - YEAR_IN_SECONDS, SITECOOKIEPATH, COOKIE_DOMAIN );
// Old cookies
- setcookie(AUTH_COOKIE, ' ', time() - 31536000, COOKIEPATH, COOKIE_DOMAIN);
- setcookie(AUTH_COOKIE, ' ', time() - 31536000, SITECOOKIEPATH, COOKIE_DOMAIN);
- setcookie(SECURE_AUTH_COOKIE, ' ', time() - 31536000, COOKIEPATH, COOKIE_DOMAIN);
- setcookie(SECURE_AUTH_COOKIE, ' ', time() - 31536000, SITECOOKIEPATH, COOKIE_DOMAIN);
+ setcookie( AUTH_COOKIE, ' ', time() - YEAR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN );
+ setcookie( AUTH_COOKIE, ' ', time() - YEAR_IN_SECONDS, SITECOOKIEPATH, COOKIE_DOMAIN );
+ setcookie( SECURE_AUTH_COOKIE, ' ', time() - YEAR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN );
+ setcookie( SECURE_AUTH_COOKIE, ' ', time() - YEAR_IN_SECONDS, SITECOOKIEPATH, COOKIE_DOMAIN );
// Even older cookies
- setcookie(USER_COOKIE, ' ', time() - 31536000, COOKIEPATH, COOKIE_DOMAIN);
- setcookie(PASS_COOKIE, ' ', time() - 31536000, COOKIEPATH, COOKIE_DOMAIN);
- setcookie(USER_COOKIE, ' ', time() - 31536000, SITECOOKIEPATH, COOKIE_DOMAIN);
- setcookie(PASS_COOKIE, ' ', time() - 31536000, SITECOOKIEPATH, COOKIE_DOMAIN);
+ setcookie( USER_COOKIE, ' ', time() - YEAR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN );
+ setcookie( PASS_COOKIE, ' ', time() - YEAR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN );
+ setcookie( USER_COOKIE, ' ', time() - YEAR_IN_SECONDS, SITECOOKIEPATH, COOKIE_DOMAIN );
+ setcookie( PASS_COOKIE, ' ', time() - YEAR_IN_SECONDS, SITECOOKIEPATH, COOKIE_DOMAIN );
}
endif;
function is_user_logged_in() {
$user = wp_get_current_user();
- if ( $user->id == 0 )
- return false;
-
- return true;
+ return $user->exists();
}
endif;
/**
* Checks if a user is logged in, if not it redirects them to the login page.
*
- * @since 1.5
+ * @since 1.5.0
*/
function auth_redirect() {
// Checks if a user is logged in, if not redirects them to the login page
- if ( is_ssl() || force_ssl_admin() )
- $secure = true;
- else
- $secure = false;
+ $secure = ( is_ssl() || force_ssl_admin() );
+
+ /**
+ * Filter whether to use a secure authentication redirect.
+ *
+ * @since 3.1.0
+ *
+ * @param bool $secure Whether to use a secure authentication redirect. Default false.
+ */
+ $secure = apply_filters( 'secure_auth_redirect', $secure );
// If https is required and request is http, redirect
if ( $secure && !is_ssl() && false !== strpos($_SERVER['REQUEST_URI'], 'wp-admin') ) {
- if ( 0 === strpos($_SERVER['REQUEST_URI'], 'http') ) {
- wp_redirect(preg_replace('|^http://|', 'https://', $_SERVER['REQUEST_URI']));
+ if ( 0 === strpos( $_SERVER['REQUEST_URI'], 'http' ) ) {
+ wp_redirect( set_url_scheme( $_SERVER['REQUEST_URI'], 'https' ) );
exit();
} else {
- wp_redirect('https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI']);
+ wp_redirect( 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );
exit();
}
}
- if ( $user_id = wp_validate_auth_cookie() ) {
- do_action('auth_redirect', $user_id);
+ if ( is_user_admin() ) {
+ $scheme = 'logged_in';
+ } else {
+ /**
+ * Filter the authentication redirect scheme.
+ *
+ * @since 2.9.0
+ *
+ * @param string $scheme Authentication redirect scheme. Default empty.
+ */
+ $scheme = apply_filters( 'auth_redirect_scheme', '' );
+ }
+
+ if ( $user_id = wp_validate_auth_cookie( '', $scheme) ) {
+ /**
+ * Fires before the authentication redirect.
+ *
+ * @since 2.8.0
+ *
+ * @param int $user_id User ID.
+ */
+ do_action( 'auth_redirect', $user_id );
// If the user wants ssl but the session is not ssl, redirect.
if ( !$secure && get_user_option('use_ssl', $user_id) && false !== strpos($_SERVER['REQUEST_URI'], 'wp-admin') ) {
- if ( 0 === strpos($_SERVER['REQUEST_URI'], 'http') ) {
- wp_redirect(preg_replace('|^http://|', 'https://', $_SERVER['REQUEST_URI']));
+ if ( 0 === strpos( $_SERVER['REQUEST_URI'], 'http' ) ) {
+ wp_redirect( set_url_scheme( $_SERVER['REQUEST_URI'], 'https' ) );
exit();
} else {
- wp_redirect('https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI']);
+ wp_redirect( 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );
exit();
}
}
// The cookie is no good so force login
nocache_headers();
- if ( is_ssl() )
- $proto = 'https://';
- else
- $proto = 'http://';
-
- $redirect = ( strpos($_SERVER['REQUEST_URI'], '/options.php') && wp_get_referer() ) ? wp_get_referer() : $proto . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'];
+ $redirect = ( strpos( $_SERVER['REQUEST_URI'], '/options.php' ) && wp_get_referer() ) ? wp_get_referer() : set_url_scheme( 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );
- $login_url = wp_login_url($redirect);
+ $login_url = wp_login_url($redirect, true);
wp_redirect($login_url);
exit();
* To avoid security exploits.
*
* @since 1.2.0
- * @uses do_action() Calls 'check_admin_referer' on $action.
*
- * @param string $action Action nonce
- * @param string $query_arg where to look for nonce in $_REQUEST (since 2.5)
+ * @param int|string $action Action nonce.
+ * @param string $query_arg Optional. Key to check for nonce in `$_REQUEST` (since 2.5).
+ * Default '_wpnonce'.
+ * @return false|int False if the nonce is invalid, 1 if the nonce is valid and generated between
+ * 0-12 hours ago, 2 if the nonce is valid and generated between 12-24 hours ago.
*/
-function check_admin_referer($action = -1, $query_arg = '_wpnonce') {
+function check_admin_referer( $action = -1, $query_arg = '_wpnonce' ) {
+ if ( -1 == $action )
+ _doing_it_wrong( __FUNCTION__, __( 'You should specify a nonce action to be verified by using the first parameter.' ), '3.2' );
+
$adminurl = strtolower(admin_url());
$referer = strtolower(wp_get_referer());
$result = isset($_REQUEST[$query_arg]) ? wp_verify_nonce($_REQUEST[$query_arg], $action) : false;
- if ( !$result && !(-1 == $action && strpos($referer, $adminurl) !== false) ) {
- wp_nonce_ays($action);
+
+ /**
+ * Fires once the admin request has been validated or not.
+ *
+ * @since 1.5.1
+ *
+ * @param string $action The nonce action.
+ * @param false|int $result False if the nonce is invalid, 1 if the nonce is valid and generated between
+ * 0-12 hours ago, 2 if the nonce is valid and generated between 12-24 hours ago.
+ */
+ do_action( 'check_admin_referer', $action, $result );
+
+ if ( ! $result && ! ( -1 == $action && strpos( $referer, $adminurl ) === 0 ) ) {
+ wp_nonce_ays( $action );
die();
}
- do_action('check_admin_referer', $action, $result);
+
return $result;
-}endif;
+}
+endif;
if ( !function_exists('check_ajax_referer') ) :
/**
*
* @since 2.0.3
*
- * @param string $action Action nonce
- * @param string $query_arg where to look for nonce in $_REQUEST (since 2.5)
+ * @param int|string $action Action nonce.
+ * @param false|string $query_arg Optional. Key to check for the nonce in `$_REQUEST` (since 2.5). If false,
+ * `$_REQUEST` values will be evaluated for '_ajax_nonce', and '_wpnonce'
+ * (in that order). Default false.
+ * @param bool $die Optional. Whether to die early when the nonce cannot be verified.
+ * Default true.
+ * @return false|int False if the nonce is invalid, 1 if the nonce is valid and generated between
+ * 0-12 hours ago, 2 if the nonce is valid and generated between 12-24 hours ago.
*/
function check_ajax_referer( $action = -1, $query_arg = false, $die = true ) {
- if ( $query_arg )
- $nonce = $_REQUEST[$query_arg];
- else
- $nonce = $_REQUEST['_ajax_nonce'] ? $_REQUEST['_ajax_nonce'] : $_REQUEST['_wpnonce'];
+ $nonce = '';
+
+ if ( $query_arg && isset( $_REQUEST[ $query_arg ] ) )
+ $nonce = $_REQUEST[ $query_arg ];
+ elseif ( isset( $_REQUEST['_ajax_nonce'] ) )
+ $nonce = $_REQUEST['_ajax_nonce'];
+ elseif ( isset( $_REQUEST['_wpnonce'] ) )
+ $nonce = $_REQUEST['_wpnonce'];
$result = wp_verify_nonce( $nonce, $action );
- if ( $die && false == $result )
- die('-1');
+ if ( $die && false === $result ) {
+ if ( defined( 'DOING_AJAX' ) && DOING_AJAX )
+ wp_die( -1 );
+ else
+ die( '-1' );
+ }
- do_action('check_ajax_referer', $action, $result);
+ /**
+ * Fires once the AJAX request has been validated or not.
+ *
+ * @since 2.1.0
+ *
+ * @param string $action The AJAX nonce action.
+ * @param false|int $result False if the nonce is invalid, 1 if the nonce is valid and generated between
+ * 0-12 hours ago, 2 if the nonce is valid and generated between 12-24 hours ago.
+ */
+ do_action( 'check_ajax_referer', $action, $result );
return $result;
}
if ( !function_exists('wp_redirect') ) :
/**
- * Redirects to another page, with a workaround for the IIS Set-Cookie bug.
+ * Redirects to another page.
*
- * @link http://support.microsoft.com/kb/q176113/
* @since 1.5.1
- * @uses apply_filters() Calls 'wp_redirect' hook on $location and $status.
*
- * @param string $location The path to redirect to
- * @param int $status Status code to use
- * @return bool False if $location is not set
+ * @global bool $is_IIS
+ *
+ * @param string $location The path to redirect to.
+ * @param int $status Status code to use.
+ * @return bool False if $location is not provided, true otherwise.
*/
function wp_redirect($location, $status = 302) {
global $is_IIS;
- $location = apply_filters('wp_redirect', $location, $status);
- $status = apply_filters('wp_redirect_status', $status, $location);
+ /**
+ * Filter the redirect location.
+ *
+ * @since 2.1.0
+ *
+ * @param string $location The path to redirect to.
+ * @param int $status Status code to use.
+ */
+ $location = apply_filters( 'wp_redirect', $location, $status );
+
+ /**
+ * Filter the redirect status code.
+ *
+ * @since 2.3.0
+ *
+ * @param int $status Status code to use.
+ * @param string $location The path to redirect to.
+ */
+ $status = apply_filters( 'wp_redirect_status', $status, $location );
- if ( !$location ) // allows the wp_redirect filter to cancel a redirect
+ if ( ! $location )
return false;
$location = wp_sanitize_redirect($location);
- if ( $is_IIS ) {
- header("Refresh: 0;url=$location");
- } else {
- if ( php_sapi_name() != 'cgi-fcgi' )
- status_header($status); // This causes problems on IIS and some FastCGI setups
- header("Location: $location");
- }
+ if ( !$is_IIS && PHP_SAPI != 'cgi-fcgi' )
+ status_header($status); // This causes problems on IIS and some FastCGI setups
+
+ header("Location: $location", true, $status);
+
+ return true;
}
endif;
/**
* Sanitizes a URL for use in a redirect.
*
- * @since 2.3
+ * @since 2.3.0
*
* @return string redirect-sanitized URL
**/
function wp_sanitize_redirect($location) {
- $location = preg_replace('|[^a-z0-9-~+_.?#=&;,/:%!]|i', '', $location);
+ $regex = '/
+ (
+ (?: [\xC2-\xDF][\x80-\xBF] # double-byte sequences 110xxxxx 10xxxxxx
+ | \xE0[\xA0-\xBF][\x80-\xBF] # triple-byte sequences 1110xxxx 10xxxxxx * 2
+ | [\xE1-\xEC][\x80-\xBF]{2}
+ | \xED[\x80-\x9F][\x80-\xBF]
+ | [\xEE-\xEF][\x80-\xBF]{2}
+ | \xF0[\x90-\xBF][\x80-\xBF]{2} # four-byte sequences 11110xxx 10xxxxxx * 3
+ | [\xF1-\xF3][\x80-\xBF]{3}
+ | \xF4[\x80-\x8F][\x80-\xBF]{2}
+ ){1,40} # ...one or more times
+ )/x';
+ $location = preg_replace_callback( $regex, '_wp_sanitize_utf8_in_redirect', $location );
+ $location = preg_replace('|[^a-z0-9-~+_.?#=&;,/:%!*\[\]()]|i', '', $location);
$location = wp_kses_no_null($location);
// remove %0d and %0a from location
$strip = array('%0d', '%0a', '%0D', '%0A');
- $location = _deep_replace($strip, $location);
- return $location;
+ return _deep_replace( $strip, $location );
+}
+
+/**
+ * URL encode UTF-8 characters in a URL.
+ *
+ * @ignore
+ * @since 4.2.0
+ * @access private
+ *
+ * @see wp_sanitize_redirect()
+ */
+function _wp_sanitize_utf8_in_redirect( $matches ) {
+ return urlencode( $matches[0] );
}
endif;
* path. A plugin can therefore set or remove allowed host(s) to or from the
* list.
*
- * If the host is not allowed, then the redirect is to wp-admin on the siteurl
+ * If the host is not allowed, then the redirect defaults to wp-admin on the siteurl
* instead. This prevents malicious redirects which redirect to another host,
* but only used in a few places.
*
- * @since 2.3
- * @uses wp_validate_redirect() To validate the redirect is to an allowed host.
- *
- * @return void Does not return anything
- **/
+ * @since 2.3.0
+ */
function wp_safe_redirect($location, $status = 302) {
// Need to look at the URL the way it will end up in wp_redirect()
$location = wp_sanitize_redirect($location);
- $location = wp_validate_redirect($location, admin_url());
+ /**
+ * Filter the redirect fallback URL for when the provided redirect is not safe (local).
+ *
+ * @since 4.3.0
+ *
+ * @param string $fallback_url The fallback URL to use by default.
+ * @param int $status The redirect status.
+ */
+ $location = wp_validate_redirect( $location, apply_filters( 'wp_safe_redirect_fallback', admin_url(), $status ) );
wp_redirect($location, $status);
}
* If the host is not allowed, then the redirect is to $default supplied
*
* @since 2.8.1
- * @uses apply_filters() Calls 'allowed_redirect_hosts' on an array containing
- * WordPress host string and $location host string.
*
* @param string $location The redirect to validate
- * @param string $default The value to return is $location is not allowed
+ * @param string $default The value to return if $location is not allowed
* @return string redirect-sanitized URL
**/
function wp_validate_redirect($location, $default = '') {
+ $location = trim( $location );
// browsers will assume 'http' is your protocol, and will obey a redirect to a URL starting with '//'
if ( substr($location, 0, 2) == '//' )
$location = 'http:' . $location;
$test = ( $cut = strpos($location, '?') ) ? substr( $location, 0, $cut ) : $location;
$lp = parse_url($test);
- $wpp = parse_url(get_option('home'));
- $allowed_hosts = (array) apply_filters('allowed_redirect_hosts', array($wpp['host']), isset($lp['host']) ? $lp['host'] : '');
+ // Give up if malformed URL
+ if ( false === $lp )
+ return $default;
+
+ // Allow only http and https schemes. No data:, etc.
+ if ( isset($lp['scheme']) && !('http' == $lp['scheme'] || 'https' == $lp['scheme']) )
+ return $default;
+
+ // 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.
+ if ( isset($lp['scheme']) && !isset($lp['host']) )
+ return $default;
+
+ $wpp = parse_url(home_url());
+
+ /**
+ * Filter the whitelist of hosts to redirect to.
+ *
+ * @since 2.3.0
+ *
+ * @param array $hosts An array of allowed hosts.
+ * @param bool|string $host The parsed host; empty if not isset.
+ */
+ $allowed_hosts = (array) apply_filters( 'allowed_redirect_hosts', array($wpp['host']), isset($lp['host']) ? $lp['host'] : '' );
if ( isset($lp['host']) && ( !in_array($lp['host'], $allowed_hosts) && $lp['host'] != strtolower($wpp['host'])) )
$location = $default;
if ( ! function_exists('wp_notify_postauthor') ) :
/**
- * Notify an author of a comment/trackback/pingback to one of their posts.
+ * Notify an author (and/or others) of a comment/trackback/pingback on a post.
*
* @since 1.0.0
*
- * @param int $comment_id Comment ID
- * @param string $comment_type Optional. The comment type either 'comment' (default), 'trackback', or 'pingback'
- * @return bool False if user email does not exist. True on completion.
+ * @param int $comment_id Comment ID
+ * @param string $deprecated Not used
+ * @return bool True on completion. False if no email addresses were specified.
*/
-function wp_notify_postauthor($comment_id, $comment_type='') {
- $comment = get_comment($comment_id);
- $post = get_post($comment->comment_post_ID);
- $user = get_userdata( $post->post_author );
- $current_user = wp_get_current_user();
+function wp_notify_postauthor( $comment_id, $deprecated = null ) {
+ if ( null !== $deprecated ) {
+ _deprecated_argument( __FUNCTION__, '3.8' );
+ }
- if ( $comment->user_id == $post->post_author ) return false; // The author moderated a comment on his own post
+ $comment = get_comment( $comment_id );
+ if ( empty( $comment ) )
+ return false;
+
+ $post = get_post( $comment->comment_post_ID );
+ $author = get_userdata( $post->post_author );
- if ('' == $user->user_email) return false; // If there's no email to send the comment to
+ // Who to notify? By default, just the post author, but others can be added.
+ $emails = array();
+ if ( $author ) {
+ $emails[] = $author->user_email;
+ }
+
+ /**
+ * Filter the list of email addresses to receive a comment notification.
+ *
+ * By default, only post authors are notified of comments. This filter allows
+ * others to be added.
+ *
+ * @since 3.7.0
+ *
+ * @param array $emails An array of email addresses to receive a comment notification.
+ * @param int $comment_id The comment ID.
+ */
+ $emails = apply_filters( 'comment_notification_recipients', $emails, $comment_id );
+ $emails = array_filter( $emails );
+
+ // If there are no addresses to send the comment to, bail.
+ if ( ! count( $emails ) ) {
+ return false;
+ }
+
+ // Facilitate unsetting below without knowing the keys.
+ $emails = array_flip( $emails );
+
+ /**
+ * Filter whether to notify comment authors of their comments on their own posts.
+ *
+ * By default, comment authors aren't notified of their comments on their own
+ * posts. This filter allows you to override that.
+ *
+ * @since 3.8.0
+ *
+ * @param bool $notify Whether to notify the post author of their own comment.
+ * Default false.
+ * @param int $comment_id The comment ID.
+ */
+ $notify_author = apply_filters( 'comment_notification_notify_author', false, $comment_id );
+
+ // The comment was left by the author
+ if ( $author && ! $notify_author && $comment->user_id == $post->post_author ) {
+ unset( $emails[ $author->user_email ] );
+ }
+
+ // The author moderated a comment on their own post
+ if ( $author && ! $notify_author && $post->post_author == get_current_user_id() ) {
+ unset( $emails[ $author->user_email ] );
+ }
+
+ // The post author is no longer a member of the blog
+ if ( $author && ! $notify_author && ! user_can( $post->post_author, 'read_post', $post->ID ) ) {
+ unset( $emails[ $author->user_email ] );
+ }
+
+ // If there's no email to send the comment to, bail, otherwise flip array back around for use below
+ if ( ! count( $emails ) ) {
+ return false;
+ } else {
+ $emails = array_flip( $emails );
+ }
$comment_author_domain = @gethostbyaddr($comment->comment_author_IP);
- $blogname = get_option('blogname');
-
- if ( empty( $comment_type ) ) $comment_type = 'comment';
-
- if ('comment' == $comment_type) {
- /* translators: 1: post id, 2: post title */
- $notify_message = sprintf( __('New comment on your post #%1$s "%2$s"'), $comment->comment_post_ID, $post->post_title ) . "\r\n";
- /* translators: 1: comment author, 2: author IP, 3: author domain */
- $notify_message .= sprintf( __('Author : %1$s (IP: %2$s , %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
- $notify_message .= sprintf( __('E-mail : %s'), $comment->comment_author_email ) . "\r\n";
- $notify_message .= sprintf( __('URL : %s'), $comment->comment_author_url ) . "\r\n";
- $notify_message .= sprintf( __('Whois : http://ws.arin.net/cgi-bin/whois.pl?queryinput=%s'), $comment->comment_author_IP ) . "\r\n";
- $notify_message .= __('Comment: ') . "\r\n" . $comment->comment_content . "\r\n\r\n";
- $notify_message .= __('You can see all comments on this post here: ') . "\r\n";
- /* translators: 1: blog name, 2: post title */
- $subject = sprintf( __('[%1$s] Comment: "%2$s"'), $blogname, $post->post_title );
- } elseif ('trackback' == $comment_type) {
- /* translators: 1: post id, 2: post title */
- $notify_message = sprintf( __('New trackback on your post #%1$s "%2$s"'), $comment->comment_post_ID, $post->post_title ) . "\r\n";
- /* translators: 1: website name, 2: author IP, 3: author domain */
- $notify_message .= sprintf( __('Website: %1$s (IP: %2$s , %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
- $notify_message .= sprintf( __('URL : %s'), $comment->comment_author_url ) . "\r\n";
- $notify_message .= __('Excerpt: ') . "\r\n" . $comment->comment_content . "\r\n\r\n";
- $notify_message .= __('You can see all trackbacks on this post here: ') . "\r\n";
- /* translators: 1: blog name, 2: post title */
- $subject = sprintf( __('[%1$s] Trackback: "%2$s"'), $blogname, $post->post_title );
- } elseif ('pingback' == $comment_type) {
- /* translators: 1: post id, 2: post title */
- $notify_message = sprintf( __('New pingback on your post #%1$s "%2$s"'), $comment->comment_post_ID, $post->post_title ) . "\r\n";
- /* translators: 1: comment author, 2: author IP, 3: author domain */
- $notify_message .= sprintf( __('Website: %1$s (IP: %2$s , %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
- $notify_message .= sprintf( __('URL : %s'), $comment->comment_author_url ) . "\r\n";
- $notify_message .= __('Excerpt: ') . "\r\n" . sprintf('[...] %s [...]', $comment->comment_content ) . "\r\n\r\n";
- $notify_message .= __('You can see all pingbacks on this post here: ') . "\r\n";
- /* translators: 1: blog name, 2: post title */
- $subject = sprintf( __('[%1$s] Pingback: "%2$s"'), $blogname, $post->post_title );
+ // The blogname option is escaped with esc_html on the way into the database in sanitize_option
+ // we want to reverse this for the plain text arena of emails.
+ $blogname = wp_specialchars_decode(get_option('blogname'), ENT_QUOTES);
+
+ switch ( $comment->comment_type ) {
+ case 'trackback':
+ $notify_message = sprintf( __( 'New trackback on your post "%s"' ), $post->post_title ) . "\r\n";
+ /* translators: 1: website name, 2: website IP, 3: website hostname */
+ $notify_message .= sprintf( __('Website: %1$s (IP: %2$s, %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
+ $notify_message .= sprintf( __( 'URL: %s' ), $comment->comment_author_url ) . "\r\n";
+ $notify_message .= sprintf( __( 'Comment: %s' ), "\r\n" . $comment->comment_content ) . "\r\n\r\n";
+ $notify_message .= __( 'You can see all trackbacks on this post here:' ) . "\r\n";
+ /* translators: 1: blog name, 2: post title */
+ $subject = sprintf( __('[%1$s] Trackback: "%2$s"'), $blogname, $post->post_title );
+ break;
+ case 'pingback':
+ $notify_message = sprintf( __( 'New pingback on your post "%s"' ), $post->post_title ) . "\r\n";
+ /* translators: 1: website name, 2: website IP, 3: website hostname */
+ $notify_message .= sprintf( __('Website: %1$s (IP: %2$s, %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
+ $notify_message .= sprintf( __( 'URL: %s' ), $comment->comment_author_url ) . "\r\n";
+ $notify_message .= sprintf( __( 'Comment: %s' ), "\r\n" . $comment->comment_content ) . "\r\n\r\n";
+ $notify_message .= __( 'You can see all pingbacks on this post here:' ) . "\r\n";
+ /* translators: 1: blog name, 2: post title */
+ $subject = sprintf( __('[%1$s] Pingback: "%2$s"'), $blogname, $post->post_title );
+ break;
+ default: // Comments
+ $notify_message = sprintf( __( 'New comment on your post "%s"' ), $post->post_title ) . "\r\n";
+ /* translators: 1: comment author, 2: author IP, 3: author domain */
+ $notify_message .= sprintf( __( 'Author: %1$s (IP: %2$s, %3$s)' ), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
+ $notify_message .= sprintf( __( 'E-mail: %s' ), $comment->comment_author_email ) . "\r\n";
+ $notify_message .= sprintf( __( 'URL: %s' ), $comment->comment_author_url ) . "\r\n";
+ $notify_message .= sprintf( __('Comment: %s' ), "\r\n" . $comment->comment_content ) . "\r\n\r\n";
+ $notify_message .= __( 'You can see all comments on this post here:' ) . "\r\n";
+ /* translators: 1: blog name, 2: post title */
+ $subject = sprintf( __('[%1$s] Comment: "%2$s"'), $blogname, $post->post_title );
+ break;
}
$notify_message .= get_permalink($comment->comment_post_ID) . "#comments\r\n\r\n";
- $notify_message .= sprintf( __('Delete it: %s'), admin_url("comment.php?action=cdc&c=$comment_id") ) . "\r\n";
- $notify_message .= sprintf( __('Spam it: %s'), admin_url("comment.php?action=cdc&dt=spam&c=$comment_id") ) . "\r\n";
+ $notify_message .= sprintf( __('Permalink: %s'), get_comment_link( $comment_id ) ) . "\r\n";
+
+ if ( user_can( $post->post_author, 'edit_comment', $comment_id ) ) {
+ if ( EMPTY_TRASH_DAYS )
+ $notify_message .= sprintf( __('Trash it: %s'), admin_url("comment.php?action=trash&c=$comment_id") ) . "\r\n";
+ else
+ $notify_message .= sprintf( __('Delete it: %s'), admin_url("comment.php?action=delete&c=$comment_id") ) . "\r\n";
+ $notify_message .= sprintf( __('Spam it: %s'), admin_url("comment.php?action=spam&c=$comment_id") ) . "\r\n";
+ }
$wp_email = 'wordpress@' . preg_replace('#^www\.#', '', strtolower($_SERVER['SERVER_NAME']));
if ( isset($reply_to) )
$message_headers .= $reply_to . "\n";
- $notify_message = apply_filters('comment_notification_text', $notify_message, $comment_id);
- $subject = apply_filters('comment_notification_subject', $subject, $comment_id);
- $message_headers = apply_filters('comment_notification_headers', $message_headers, $comment_id);
+ /**
+ * Filter the comment notification email text.
+ *
+ * @since 1.5.2
+ *
+ * @param string $notify_message The comment notification email text.
+ * @param int $comment_id Comment ID.
+ */
+ $notify_message = apply_filters( 'comment_notification_text', $notify_message, $comment_id );
+
+ /**
+ * Filter the comment notification email subject.
+ *
+ * @since 1.5.2
+ *
+ * @param string $subject The comment notification email subject.
+ * @param int $comment_id Comment ID.
+ */
+ $subject = apply_filters( 'comment_notification_subject', $subject, $comment_id );
+
+ /**
+ * Filter the comment notification email headers.
+ *
+ * @since 1.5.2
+ *
+ * @param string $message_headers Headers for the comment notification email.
+ * @param int $comment_id Comment ID.
+ */
+ $message_headers = apply_filters( 'comment_notification_headers', $message_headers, $comment_id );
- @wp_mail($user->user_email, $subject, $notify_message, $message_headers);
+ foreach ( $emails as $email ) {
+ @wp_mail( $email, wp_specialchars_decode( $subject ), $notify_message, $message_headers );
+ }
return true;
}
/**
* Notifies the moderator of the blog about a new comment that is awaiting approval.
*
- * @since 1.0
- * @uses $wpdb
+ * @since 1.0.0
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
*
* @param int $comment_id Comment ID
- * @return bool Always returns true
+ * @return true Always returns true
*/
function wp_notify_moderator($comment_id) {
global $wpdb;
- if( get_option( "moderation_notify" ) == 0 )
+ if ( 0 == get_option( 'moderation_notify' ) )
return true;
- $comment = $wpdb->get_row($wpdb->prepare("SELECT * FROM $wpdb->comments WHERE comment_ID=%d LIMIT 1", $comment_id));
- $post = $wpdb->get_row($wpdb->prepare("SELECT * FROM $wpdb->posts WHERE ID=%d LIMIT 1", $comment->comment_post_ID));
+ $comment = get_comment($comment_id);
+ $post = get_post($comment->comment_post_ID);
+ $user = get_userdata( $post->post_author );
+ // Send to the administration and to the post author if the author can modify the comment.
+ $emails = array( get_option( 'admin_email' ) );
+ if ( $user && user_can( $user->ID, 'edit_comment', $comment_id ) && ! empty( $user->user_email ) ) {
+ if ( 0 !== strcasecmp( $user->user_email, get_option( 'admin_email' ) ) )
+ $emails[] = $user->user_email;
+ }
$comment_author_domain = @gethostbyaddr($comment->comment_author_IP);
$comments_waiting = $wpdb->get_var("SELECT count(comment_ID) FROM $wpdb->comments WHERE comment_approved = '0'");
- switch ($comment->comment_type)
- {
+ // The blogname option is escaped with esc_html on the way into the database in sanitize_option
+ // we want to reverse this for the plain text arena of emails.
+ $blogname = wp_specialchars_decode(get_option('blogname'), ENT_QUOTES);
+
+ switch ( $comment->comment_type ) {
case 'trackback':
- $notify_message = sprintf( __('A new trackback on the post #%1$s "%2$s" is waiting for your approval'), $post->ID, $post->post_title ) . "\r\n";
+ $notify_message = sprintf( __('A new trackback on the post "%s" is waiting for your approval'), $post->post_title ) . "\r\n";
$notify_message .= get_permalink($comment->comment_post_ID) . "\r\n\r\n";
- $notify_message .= sprintf( __('Website : %1$s (IP: %2$s , %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
- $notify_message .= sprintf( __('URL : %s'), $comment->comment_author_url ) . "\r\n";
+ /* translators: 1: website name, 2: website IP, 3: website hostname */
+ $notify_message .= sprintf( __( 'Website: %1$s (IP: %2$s, %3$s)' ), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
+ $notify_message .= sprintf( __( 'URL: %s' ), $comment->comment_author_url ) . "\r\n";
$notify_message .= __('Trackback excerpt: ') . "\r\n" . $comment->comment_content . "\r\n\r\n";
break;
case 'pingback':
- $notify_message = sprintf( __('A new pingback on the post #%1$s "%2$s" is waiting for your approval'), $post->ID, $post->post_title ) . "\r\n";
+ $notify_message = sprintf( __('A new pingback on the post "%s" is waiting for your approval'), $post->post_title ) . "\r\n";
$notify_message .= get_permalink($comment->comment_post_ID) . "\r\n\r\n";
- $notify_message .= sprintf( __('Website : %1$s (IP: %2$s , %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
- $notify_message .= sprintf( __('URL : %s'), $comment->comment_author_url ) . "\r\n";
+ /* translators: 1: website name, 2: website IP, 3: website hostname */
+ $notify_message .= sprintf( __( 'Website: %1$s (IP: %2$s, %3$s)' ), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
+ $notify_message .= sprintf( __( 'URL: %s' ), $comment->comment_author_url ) . "\r\n";
$notify_message .= __('Pingback excerpt: ') . "\r\n" . $comment->comment_content . "\r\n\r\n";
break;
- default: //Comments
- $notify_message = sprintf( __('A new comment on the post #%1$s "%2$s" is waiting for your approval'), $post->ID, $post->post_title ) . "\r\n";
+ default: // Comments
+ $notify_message = sprintf( __('A new comment on the post "%s" is waiting for your approval'), $post->post_title ) . "\r\n";
$notify_message .= get_permalink($comment->comment_post_ID) . "\r\n\r\n";
- $notify_message .= sprintf( __('Author : %1$s (IP: %2$s , %3$s)'), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
- $notify_message .= sprintf( __('E-mail : %s'), $comment->comment_author_email ) . "\r\n";
- $notify_message .= sprintf( __('URL : %s'), $comment->comment_author_url ) . "\r\n";
- $notify_message .= sprintf( __('Whois : http://ws.arin.net/cgi-bin/whois.pl?queryinput=%s'), $comment->comment_author_IP ) . "\r\n";
- $notify_message .= __('Comment: ') . "\r\n" . $comment->comment_content . "\r\n\r\n";
+ $notify_message .= sprintf( __( 'Author: %1$s (IP: %2$s, %3$s)' ), $comment->comment_author, $comment->comment_author_IP, $comment_author_domain ) . "\r\n";
+ $notify_message .= sprintf( __( 'E-mail: %s' ), $comment->comment_author_email ) . "\r\n";
+ $notify_message .= sprintf( __( 'URL: %s' ), $comment->comment_author_url ) . "\r\n";
+ $notify_message .= sprintf( __( 'Comment: %s' ), "\r\n" . $comment->comment_content ) . "\r\n\r\n";
break;
}
- $notify_message .= sprintf( __('Approve it: %s'), admin_url("comment.php?action=mac&c=$comment_id") ) . "\r\n";
- $notify_message .= sprintf( __('Delete it: %s'), admin_url("comment.php?action=cdc&c=$comment_id") ) . "\r\n";
- $notify_message .= sprintf( __('Spam it: %s'), admin_url("comment.php?action=cdc&dt=spam&c=$comment_id") ) . "\r\n";
+ $notify_message .= sprintf( __('Approve it: %s'), admin_url("comment.php?action=approve&c=$comment_id") ) . "\r\n";
+ if ( EMPTY_TRASH_DAYS )
+ $notify_message .= sprintf( __('Trash it: %s'), admin_url("comment.php?action=trash&c=$comment_id") ) . "\r\n";
+ else
+ $notify_message .= sprintf( __('Delete it: %s'), admin_url("comment.php?action=delete&c=$comment_id") ) . "\r\n";
+ $notify_message .= sprintf( __('Spam it: %s'), admin_url("comment.php?action=spam&c=$comment_id") ) . "\r\n";
$notify_message .= sprintf( _n('Currently %s comment is waiting for approval. Please visit the moderation panel:',
'Currently %s comments are waiting for approval. Please visit the moderation panel:', $comments_waiting), number_format_i18n($comments_waiting) ) . "\r\n";
$notify_message .= admin_url("edit-comments.php?comment_status=moderated") . "\r\n";
- $subject = sprintf( __('[%1$s] Please moderate: "%2$s"'), get_option('blogname'), $post->post_title );
- $admin_email = get_option('admin_email');
+ $subject = sprintf( __('[%1$s] Please moderate: "%2$s"'), $blogname, $post->post_title );
$message_headers = '';
- $notify_message = apply_filters('comment_moderation_text', $notify_message, $comment_id);
- $subject = apply_filters('comment_moderation_subject', $subject, $comment_id);
- $message_headers = apply_filters('comment_moderation_headers', $message_headers);
+ /**
+ * Filter the list of recipients for comment moderation emails.
+ *
+ * @since 3.7.0
+ *
+ * @param array $emails List of email addresses to notify for comment moderation.
+ * @param int $comment_id Comment ID.
+ */
+ $emails = apply_filters( 'comment_moderation_recipients', $emails, $comment_id );
+
+ /**
+ * Filter the comment moderation email text.
+ *
+ * @since 1.5.2
+ *
+ * @param string $notify_message Text of the comment moderation email.
+ * @param int $comment_id Comment ID.
+ */
+ $notify_message = apply_filters( 'comment_moderation_text', $notify_message, $comment_id );
+
+ /**
+ * Filter the comment moderation email subject.
+ *
+ * @since 1.5.2
+ *
+ * @param string $subject Subject of the comment moderation email.
+ * @param int $comment_id Comment ID.
+ */
+ $subject = apply_filters( 'comment_moderation_subject', $subject, $comment_id );
+
+ /**
+ * Filter the comment moderation email headers.
+ *
+ * @since 2.8.0
+ *
+ * @param string $message_headers Headers for the comment moderation email.
+ * @param int $comment_id Comment ID.
+ */
+ $message_headers = apply_filters( 'comment_moderation_headers', $message_headers, $comment_id );
- @wp_mail($admin_email, $subject, $notify_message, $message_headers);
+ foreach ( $emails as $email ) {
+ @wp_mail( $email, wp_specialchars_decode( $subject ), $notify_message, $message_headers );
+ }
return true;
}
/**
* Notify the blog admin of a user changing password, normally via email.
*
- * @since 2.7
+ * @since 2.7.0
*
* @param object $user User Object
*/
function wp_password_change_notification(&$user) {
// send a copy of password change notification to the admin
// but check to see if it's the admin whose password we're changing, and skip this
- if ( $user->user_email != get_option('admin_email') ) {
+ if ( 0 !== strcasecmp( $user->user_email, get_option( 'admin_email' ) ) ) {
$message = sprintf(__('Password Lost and Changed for user: %s'), $user->user_login) . "\r\n";
- wp_mail(get_option('admin_email'), sprintf(__('[%s] Password Lost/Changed'), get_option('blogname')), $message);
+ // The blogname option is escaped with esc_html on the way into the database in sanitize_option
+ // we want to reverse this for the plain text arena of emails.
+ $blogname = wp_specialchars_decode(get_option('blogname'), ENT_QUOTES);
+ wp_mail(get_option('admin_email'), sprintf(__('[%s] Password Lost/Changed'), $blogname), $message);
}
}
endif;
if ( !function_exists('wp_new_user_notification') ) :
/**
- * Notify the blog admin of a new user, normally via email.
+ * Email login credentials to a newly-registered user.
*
- * @since 2.0
+ * A new user registration notification is also sent to admin email.
*
- * @param int $user_id User ID
- * @param string $plaintext_pass Optional. The user's plaintext password
+ * @since 2.0.0
+ * @since 4.3.0 The `$plaintext_pass` parameter was changed to `$notify`.
+ *
+ * @param int $user_id User ID.
+ * @param string $notify Whether admin and user should be notified ('both') or
+ * only the admin ('admin' or empty).
*/
-function wp_new_user_notification($user_id, $plaintext_pass = '') {
- $user = new WP_User($user_id);
+function wp_new_user_notification( $user_id, $notify = '' ) {
+ global $wpdb;
+ $user = get_userdata( $user_id );
- $user_login = stripslashes($user->user_login);
- $user_email = stripslashes($user->user_email);
+ // The blogname option is escaped with esc_html on the way into the database in sanitize_option
+ // we want to reverse this for the plain text arena of emails.
+ $blogname = wp_specialchars_decode(get_option('blogname'), ENT_QUOTES);
- $message = sprintf(__('New user registration on your blog %s:'), get_option('blogname')) . "\r\n\r\n";
- $message .= sprintf(__('Username: %s'), $user_login) . "\r\n\r\n";
- $message .= sprintf(__('E-mail: %s'), $user_email) . "\r\n";
+ $message = sprintf(__('New user registration on your site %s:'), $blogname) . "\r\n\r\n";
+ $message .= sprintf(__('Username: %s'), $user->user_login) . "\r\n\r\n";
+ $message .= sprintf(__('E-mail: %s'), $user->user_email) . "\r\n";
- @wp_mail(get_option('admin_email'), sprintf(__('[%s] New User Registration'), get_option('blogname')), $message);
+ @wp_mail(get_option('admin_email'), sprintf(__('[%s] New User Registration'), $blogname), $message);
- if ( empty($plaintext_pass) )
+ if ( 'admin' === $notify || empty( $notify ) ) {
return;
+ }
- $message = sprintf(__('Username: %s'), $user_login) . "\r\n";
- $message .= sprintf(__('Password: %s'), $plaintext_pass) . "\r\n";
- $message .= wp_login_url() . "\r\n";
+ // Generate something random for a password reset key.
+ $key = wp_generate_password( 20, false );
+
+ /** This action is documented in wp-login.php */
+ do_action( 'retrieve_password_key', $user->user_login, $key );
- wp_mail($user_email, sprintf(__('[%s] Your username and password'), get_option('blogname')), $message);
+ // Now insert the key, hashed, into the DB.
+ if ( empty( $wp_hasher ) ) {
+ require_once ABSPATH . WPINC . '/class-phpass.php';
+ $wp_hasher = new PasswordHash( 8, true );
+ }
+ $hashed = time() . ':' . $wp_hasher->HashPassword( $key );
+ $wpdb->update( $wpdb->users, array( 'user_activation_key' => $hashed ), array( 'user_login' => $user->user_login ) );
+
+ $message = sprintf(__('Username: %s'), $user->user_login) . "\r\n\r\n";
+ $message .= __('To set your password, visit the following address:') . "\r\n\r\n";
+ $message .= '<' . network_site_url("wp-login.php?action=rp&key=$key&login=" . rawurlencode($user->user_login), 'login') . ">\r\n\r\n";
+ $message .= wp_login_url() . "\r\n";
+
+ wp_mail($user->user_email, sprintf(__('[%s] Your username and password info'), $blogname), $message);
}
endif;
* A nonce has a lifespan of two ticks. Nonces in their second tick may be
* updated, e.g. by autosave.
*
- * @since 2.5
+ * @since 2.5.0
*
- * @return int
+ * @return float Float value rounded up to the next highest integer.
*/
function wp_nonce_tick() {
- $nonce_life = apply_filters('nonce_life', 86400);
+ /**
+ * Filter the lifespan of nonces in seconds.
+ *
+ * @since 2.5.0
+ *
+ * @param int $lifespan Lifespan of nonces in seconds. Default 86,400 seconds, or one day.
+ */
+ $nonce_life = apply_filters( 'nonce_life', DAY_IN_SECONDS );
return ceil(time() / ( $nonce_life / 2 ));
}
*
* @since 2.0.3
*
- * @param string $nonce Nonce that was used in the form to verify
+ * @param string $nonce Nonce that was used in the form to verify
* @param string|int $action Should give context to what is taking place and be the same when nonce was created.
- * @return bool Whether the nonce check passed or failed.
+ * @return false|int False if the nonce is invalid, 1 if the nonce is valid and generated between
+ * 0-12 hours ago, 2 if the nonce is valid and generated between 12-24 hours ago.
*/
-function wp_verify_nonce($nonce, $action = -1) {
+function wp_verify_nonce( $nonce, $action = -1 ) {
+ $nonce = (string) $nonce;
$user = wp_get_current_user();
- $uid = (int) $user->id;
+ $uid = (int) $user->ID;
+ if ( ! $uid ) {
+ /**
+ * Filter whether the user who generated the nonce is logged out.
+ *
+ * @since 3.5.0
+ *
+ * @param int $uid ID of the nonce-owning user.
+ * @param string $action The nonce action.
+ */
+ $uid = apply_filters( 'nonce_user_logged_out', $uid, $action );
+ }
+ if ( empty( $nonce ) ) {
+ return false;
+ }
+
+ $token = wp_get_session_token();
$i = wp_nonce_tick();
// Nonce generated 0-12 hours ago
- if ( substr(wp_hash($i . $action . $uid, 'nonce'), -12, 10) == $nonce )
+ $expected = substr( wp_hash( $i . '|' . $action . '|' . $uid . '|' . $token, 'nonce'), -12, 10 );
+ if ( hash_equals( $expected, $nonce ) ) {
return 1;
+ }
+
// Nonce generated 12-24 hours ago
- if ( substr(wp_hash(($i - 1) . $action . $uid, 'nonce'), -12, 10) == $nonce )
+ $expected = substr( wp_hash( ( $i - 1 ) . '|' . $action . '|' . $uid . '|' . $token, 'nonce' ), -12, 10 );
+ if ( hash_equals( $expected, $nonce ) ) {
return 2;
+ }
+
// Invalid nonce
return false;
}
if ( !function_exists('wp_create_nonce') ) :
/**
- * Creates a random, one time use token.
+ * Creates a cryptographic token tied to a specific action, user, and window of time.
*
* @since 2.0.3
*
* @param string|int $action Scalar value to add context to the nonce.
- * @return string The one use form token
+ * @return string The token.
*/
function wp_create_nonce($action = -1) {
$user = wp_get_current_user();
- $uid = (int) $user->id;
+ $uid = (int) $user->ID;
+ if ( ! $uid ) {
+ /** This filter is documented in wp-includes/pluggable.php */
+ $uid = apply_filters( 'nonce_user_logged_out', $uid, $action );
+ }
+ $token = wp_get_session_token();
$i = wp_nonce_tick();
- return substr(wp_hash($i . $action . $uid, 'nonce'), -12, 10);
+ return substr( wp_hash( $i . '|' . $action . '|' . $uid . '|' . $token, 'nonce' ), -12, 10 );
}
endif;
if ( !function_exists('wp_salt') ) :
/**
- * Get salt to add to hashes to help prevent attacks.
- *
- * The secret key is located in two places: the database in case the secret key
- * isn't defined in the second place, which is in the wp-config.php file. If you
- * are going to set the secret key, then you must do so in the wp-config.php
- * file.
- *
- * The secret key in the database is randomly generated and will be appended to
- * the secret key that is in wp-config.php file in some instances. It is
- * important to have the secret key defined or changed in wp-config.php.
+ * Get salt to add to hashes.
+ *
+ * Salts are created using secret keys. Secret keys are located in two places:
+ * in the database and in the wp-config.php file. The secret key in the database
+ * is randomly generated and will be appended to the secret keys in wp-config.php.
+ *
+ * The secret keys in wp-config.php should be updated to strong, random keys to maximize
+ * security. Below is an example of how the secret key constants are defined.
+ * Do not paste this example directly into wp-config.php. Instead, have a
+ * {@link https://api.wordpress.org/secret-key/1.1/salt/ secret key created} just
+ * for you.
+ *
+ * define('AUTH_KEY', ' Xakm<o xQy rw4EMsLKM-?!T+,PFF})H4lzcW57AF0U@N@< >M%G4Yt>f`z]MON');
+ * define('SECURE_AUTH_KEY', 'LzJ}op]mr|6+![P}Ak:uNdJCJZd>(Hx.-Mh#Tz)pCIU#uGEnfFz|f ;;eU%/U^O~');
+ * define('LOGGED_IN_KEY', '|i|Ux`9<p-h$aFf(qnT:sDO:D1P^wZ$$/Ra@miTJi9G;ddp_<q}6H1)o|a +&JCM');
+ * define('NONCE_KEY', '%:R{[P|,s.KuMltH5}cI;/k<Gx~j!f0I)m_sIyu+&NJZ)-iO>z7X>QYR0Z_XnZ@|');
+ * define('AUTH_SALT', 'eZyT)-Naw]F8CwA*VaW#q*|.)g@o}||wf~@C-YSt}(dh_r6EbI#A,y|nU2{B#JBW');
+ * define('SECURE_AUTH_SALT', '!=oLUTXh,QW=H `}`L|9/^4-3 STz},T(w}W<I`.JjPi)<Bmf1v,HpGe}T1:Xt7n');
+ * define('LOGGED_IN_SALT', '+XSqHc;@Q*K_b|Z?NC[3H!!EONbh.n<+=uKR:>*c(u`g~EJBf#8u#R{mUEZrozmm');
+ * define('NONCE_SALT', 'h`GXHhD>SLWVfg1(1(N{;.V!MoE(SfbA_ksP@&`+AycHcAV$+?@3q+rxV{%^VyKT');
*
- * If you have installed WordPress 2.5 or later, then you will have the
- * SECRET_KEY defined in the wp-config.php already. You will want to change the
- * value in it because hackers will know what it is. If you have upgraded to
- * WordPress 2.5 or later version from a version before WordPress 2.5, then you
- * should add the constant to your wp-config.php file.
- *
- * Below is an example of how the SECRET_KEY constant is defined with a value.
- * You must not copy the below example and paste into your wp-config.php. If you
- * need an example, then you can have a
- * {@link https://api.wordpress.org/secret-key/1.1/ secret key created} for you.
+ * Salting passwords helps against tools which has stored hashed values of
+ * common dictionary strings. The added values makes it harder to crack.
*
- * <code>
- * define('SECRET_KEY', 'mAry1HadA15|\/|b17w55w1t3asSn09w');
- * </code>
+ * @since 2.5.0
*
- * Salting passwords helps against tools which has stored hashed values of
- * common dictionary strings. The added values makes it harder to crack if given
- * salt string is not weak.
+ * @link https://api.wordpress.org/secret-key/1.1/salt/ Create secrets for wp-config.php
*
- * @since 2.5
- * @link https://api.wordpress.org/secret-key/1.1/ Create a Secret Key for wp-config.php
+ * @staticvar array $cached_salts
+ * @staticvar array $duplicated_keys
*
- * @return string Salt value from either 'SECRET_KEY' or 'secret' option
+ * @param string $scheme Authentication scheme (auth, secure_auth, logged_in, nonce)
+ * @return string Salt value
*/
-function wp_salt($scheme = 'auth') {
- global $wp_default_secret_key;
- $secret_key = '';
- if ( defined('SECRET_KEY') && ('' != SECRET_KEY) && ( $wp_default_secret_key != SECRET_KEY) )
- $secret_key = SECRET_KEY;
-
- if ( 'auth' == $scheme ) {
- if ( defined('AUTH_KEY') && ('' != AUTH_KEY) && ( $wp_default_secret_key != AUTH_KEY) )
- $secret_key = AUTH_KEY;
-
- if ( defined('AUTH_SALT') ) {
- $salt = AUTH_SALT;
- } elseif ( defined('SECRET_SALT') ) {
- $salt = SECRET_SALT;
- } else {
- $salt = get_option('auth_salt');
- if ( empty($salt) ) {
- $salt = wp_generate_password(64);
- update_option('auth_salt', $salt);
- }
- }
- } elseif ( 'secure_auth' == $scheme ) {
- if ( defined('SECURE_AUTH_KEY') && ('' != SECURE_AUTH_KEY) && ( $wp_default_secret_key != SECURE_AUTH_KEY) )
- $secret_key = SECURE_AUTH_KEY;
+function wp_salt( $scheme = 'auth' ) {
+ static $cached_salts = array();
+ if ( isset( $cached_salts[ $scheme ] ) ) {
+ /**
+ * Filter the WordPress salt.
+ *
+ * @since 2.5.0
+ *
+ * @param string $cached_salt Cached salt for the given scheme.
+ * @param string $scheme Authentication scheme. Values include 'auth',
+ * 'secure_auth', 'logged_in', and 'nonce'.
+ */
+ return apply_filters( 'salt', $cached_salts[ $scheme ], $scheme );
+ }
- if ( defined('SECURE_AUTH_SALT') ) {
- $salt = SECURE_AUTH_SALT;
- } else {
- $salt = get_option('secure_auth_salt');
- if ( empty($salt) ) {
- $salt = wp_generate_password(64);
- update_option('secure_auth_salt', $salt);
+ static $duplicated_keys;
+ if ( null === $duplicated_keys ) {
+ $duplicated_keys = array( 'put your unique phrase here' => true );
+ foreach ( array( 'AUTH', 'SECURE_AUTH', 'LOGGED_IN', 'NONCE', 'SECRET' ) as $first ) {
+ foreach ( array( 'KEY', 'SALT' ) as $second ) {
+ if ( ! defined( "{$first}_{$second}" ) ) {
+ continue;
+ }
+ $value = constant( "{$first}_{$second}" );
+ $duplicated_keys[ $value ] = isset( $duplicated_keys[ $value ] );
}
}
- } elseif ( 'logged_in' == $scheme ) {
- if ( defined('LOGGED_IN_KEY') && ('' != LOGGED_IN_KEY) && ( $wp_default_secret_key != LOGGED_IN_KEY) )
- $secret_key = LOGGED_IN_KEY;
+ }
- if ( defined('LOGGED_IN_SALT') ) {
- $salt = LOGGED_IN_SALT;
- } else {
- $salt = get_option('logged_in_salt');
- if ( empty($salt) ) {
- $salt = wp_generate_password(64);
- update_option('logged_in_salt', $salt);
- }
- }
- } elseif ( 'nonce' == $scheme ) {
- if ( defined('NONCE_KEY') && ('' != NONCE_KEY) && ( $wp_default_secret_key != NONCE_KEY) )
- $secret_key = NONCE_KEY;
+ $values = array(
+ 'key' => '',
+ 'salt' => ''
+ );
+ if ( defined( 'SECRET_KEY' ) && SECRET_KEY && empty( $duplicated_keys[ SECRET_KEY ] ) ) {
+ $values['key'] = SECRET_KEY;
+ }
+ if ( 'auth' == $scheme && defined( 'SECRET_SALT' ) && SECRET_SALT && empty( $duplicated_keys[ SECRET_SALT ] ) ) {
+ $values['salt'] = SECRET_SALT;
+ }
- if ( defined('NONCE_SALT') ) {
- $salt = NONCE_SALT;
- } else {
- $salt = get_option('nonce_salt');
- if ( empty($salt) ) {
- $salt = wp_generate_password(64);
- update_option('nonce_salt', $salt);
+ if ( in_array( $scheme, array( 'auth', 'secure_auth', 'logged_in', 'nonce' ) ) ) {
+ foreach ( array( 'key', 'salt' ) as $type ) {
+ $const = strtoupper( "{$scheme}_{$type}" );
+ if ( defined( $const ) && constant( $const ) && empty( $duplicated_keys[ constant( $const ) ] ) ) {
+ $values[ $type ] = constant( $const );
+ } elseif ( ! $values[ $type ] ) {
+ $values[ $type ] = get_site_option( "{$scheme}_{$type}" );
+ if ( ! $values[ $type ] ) {
+ $values[ $type ] = wp_generate_password( 64, true, true );
+ update_site_option( "{$scheme}_{$type}", $values[ $type ] );
+ }
}
}
} else {
- // ensure each auth scheme has its own unique salt
- $salt = hash_hmac('md5', $scheme, $secret_key);
+ if ( ! $values['key'] ) {
+ $values['key'] = get_site_option( 'secret_key' );
+ if ( ! $values['key'] ) {
+ $values['key'] = wp_generate_password( 64, true, true );
+ update_site_option( 'secret_key', $values['key'] );
+ }
+ }
+ $values['salt'] = hash_hmac( 'md5', $scheme, $values['key'] );
}
- return apply_filters('salt', $secret_key . $salt, $scheme);
+ $cached_salts[ $scheme ] = $values['key'] . $values['salt'];
+
+ /** This filter is documented in wp-includes/pluggable.php */
+ return apply_filters( 'salt', $cached_salts[ $scheme ], $scheme );
}
endif;
* Get hash of given string.
*
* @since 2.0.3
- * @uses wp_salt() Get WordPress salt
*
* @param string $data Plain text to hash
* @return string Hash of $data
* For integration with other applications, this function can be overwritten to
* instead use the other package password checking algorithm.
*
- * @since 2.5
- * @global object $wp_hasher PHPass object
- * @uses PasswordHash::HashPassword
+ * @since 2.5.0
+ *
+ * @global PasswordHash $wp_hasher PHPass object
*
* @param string $password Plain text user password to hash
* @return string The hash string of the password
global $wp_hasher;
if ( empty($wp_hasher) ) {
- require_once( ABSPATH . 'wp-includes/class-phpass.php');
+ require_once( ABSPATH . WPINC . '/class-phpass.php');
// By default, use the portable hash from phpass
- $wp_hasher = new PasswordHash(8, TRUE);
+ $wp_hasher = new PasswordHash(8, true);
}
- return $wp_hasher->HashPassword($password);
+ return $wp_hasher->HashPassword( trim( $password ) );
}
endif;
*
* Maintains compatibility between old version and the new cookie authentication
* protocol using PHPass library. The $hash parameter is the encrypted password
- * and the function compares the plain text password when encypted similarly
+ * and the function compares the plain text password when encrypted similarly
* against the already encrypted password to see if they match.
*
* For integration with other applications, this function can be overwritten to
* instead use the other package password checking algorithm.
*
- * @since 2.5
- * @global object $wp_hasher PHPass object used for checking the password
+ * @since 2.5.0
+ *
+ * @global PasswordHash $wp_hasher PHPass object used for checking the password
* against the $hash + $password
* @uses PasswordHash::CheckPassword
*
* @param string $password Plaintext user's password
- * @param string $hash Hash of the user's password to check against.
+ * @param string $hash Hash of the user's password to check against.
* @return bool False, if the $password does not match the hashed password
*/
function wp_check_password($password, $hash, $user_id = '') {
// If the hash is still md5...
if ( strlen($hash) <= 32 ) {
- $check = ( $hash == md5($password) );
+ $check = hash_equals( $hash, md5( $password ) );
if ( $check && $user_id ) {
// Rehash using new hash.
wp_set_password($password, $user_id);
$hash = wp_hash_password($password);
}
- return apply_filters('check_password', $check, $password, $hash, $user_id);
+ /**
+ * Filter whether the plaintext password matches the encrypted password.
+ *
+ * @since 2.5.0
+ *
+ * @param bool $check Whether the passwords match.
+ * @param string $password The plaintext password.
+ * @param string $hash The hashed password.
+ * @param int $user_id User ID.
+ */
+ return apply_filters( 'check_password', $check, $password, $hash, $user_id );
}
// If the stored hash is longer than an MD5, presume the
// new style phpass portable hash.
if ( empty($wp_hasher) ) {
- require_once( ABSPATH . 'wp-includes/class-phpass.php');
+ require_once( ABSPATH . WPINC . '/class-phpass.php');
// By default, use the portable hash from phpass
- $wp_hasher = new PasswordHash(8, TRUE);
+ $wp_hasher = new PasswordHash(8, true);
}
$check = $wp_hasher->CheckPassword($password, $hash);
- return apply_filters('check_password', $check, $password, $hash, $user_id);
+ /** This filter is documented in wp-includes/pluggable.php */
+ return apply_filters( 'check_password', $check, $password, $hash, $user_id );
}
endif;
/**
* Generates a random password drawn from the defined set of characters.
*
- * @since 2.5
+ * @since 2.5.0
*
- * @param int $length The length of password to generate
- * @param bool $special_chars Whether to include standard special characters
- * @return string The random password
- **/
-function wp_generate_password($length = 12, $special_chars = true) {
+ * @param int $length Optional. The length of password to generate. Default 12.
+ * @param bool $special_chars Optional. Whether to include standard special characters.
+ * Default true.
+ * @param bool $extra_special_chars Optional. Whether to include other special characters.
+ * Used when generating secret keys and salts. Default false.
+ * @return string The random password.
+ */
+function wp_generate_password( $length = 12, $special_chars = true, $extra_special_chars = false ) {
$chars = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789';
if ( $special_chars )
$chars .= '!@#$%^&*()';
+ if ( $extra_special_chars )
+ $chars .= '-_ []{}<>~`+=,.;:/?|';
$password = '';
- for ( $i = 0; $i < $length; $i++ )
+ for ( $i = 0; $i < $length; $i++ ) {
$password .= substr($chars, wp_rand(0, strlen($chars) - 1), 1);
- return $password;
+ }
+
+ /**
+ * Filter the randomly-generated password.
+ *
+ * @since 3.0.0
+ *
+ * @param string $password The generated password.
+ */
+ return apply_filters( 'random_password', $password );
}
endif;
if ( !function_exists('wp_rand') ) :
- /**
+/**
* Generates a random number
*
* @since 2.6.2
*
- * @param int $min Lower limit for the generated number (optional, default is 0)
- * @param int $max Upper limit for the generated number (optional, default is 4294967295)
+ * @global string $rnd_value
+ * @staticvar string $seed
+ *
+ * @param int $min Lower limit for the generated number
+ * @param int $max Upper limit for the generated number
* @return int A random number between min and max
*/
function wp_rand( $min = 0, $max = 0 ) {
global $rnd_value;
- $seed = get_transient('random_seed');
-
// Reset $rnd_value after 14 uses
// 32(md5) + 40(sha1) + 40(sha1) / 8 = 14 random numbers from $rnd_value
if ( strlen($rnd_value) < 8 ) {
+ if ( defined( 'WP_SETUP_CONFIG' ) )
+ static $seed = '';
+ else
+ $seed = get_transient('random_seed');
$rnd_value = md5( uniqid(microtime() . mt_rand(), true ) . $seed );
$rnd_value .= sha1($rnd_value);
$rnd_value .= sha1($rnd_value . $seed);
$seed = md5($seed . $rnd_value);
- set_transient('random_seed', $seed);
+ if ( ! defined( 'WP_SETUP_CONFIG' ) && ! defined( 'WP_INSTALLING' ) ) {
+ set_transient( 'random_seed', $seed );
+ }
}
// Take the first 8 digits for our value
$value = abs(hexdec($value));
+ // 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.
+ $max_random_number = 3000000000 === 2147483647 ? (float) "4294967295" : 4294967295; // 4294967295 = 0xffffffff
+
// Reduce the value to be within the min - max range
- // 4294967295 = 0xffffffff = max random number
if ( $max != 0 )
- $value = $min + (($max - $min + 1) * ($value / (4294967295 + 1)));
+ $value = $min + ( $max - $min + 1 ) * $value / ( $max_random_number + 1 );
return abs(intval($value));
}
* For integration with other applications, this function can be overwritten to
* instead use the other package password checking algorithm.
*
- * @since 2.5
- * @uses $wpdb WordPress database object for queries
- * @uses wp_hash_password() Used to encrypt the user's password before passing to the database
+ * Please note: This function should be used sparingly and is really only meant for single-time
+ * application. Leveraging this improperly in a plugin or theme could result in an endless loop
+ * of password resets if precautions are not taken to ensure it does not execute on every page load.
+ *
+ * @since 2.5.0
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
*
* @param string $password The plaintext new user password
- * @param int $user_id User ID
+ * @param int $user_id User ID
*/
function wp_set_password( $password, $user_id ) {
global $wpdb;
- $hash = wp_hash_password($password);
+ $hash = wp_hash_password( $password );
$wpdb->update($wpdb->users, array('user_pass' => $hash, 'user_activation_key' => ''), array('ID' => $user_id) );
wp_cache_delete($user_id, 'users');
if ( !function_exists( 'get_avatar' ) ) :
/**
- * Retrieve the avatar for a user who provided a user ID or email address.
- *
- * @since 2.5
- * @param int|string|object $id_or_email A user ID, email address, or comment object
- * @param int $size Size of the avatar image
- * @param string $default URL to a default image to use if no avatar is available
- * @param string $alt Alternate text to use in image tag. Defaults to blank
- * @return string <img> tag for the user's avatar
-*/
-function get_avatar( $id_or_email, $size = '96', $default = '', $alt = false ) {
- if ( ! get_option('show_avatars') )
- return false;
+ * Retrieve the avatar `<img>` tag for a user, email address, MD5 hash, comment, or post.
+ *
+ * @since 2.5.0
+ * @since 4.2.0 Optional `$args` parameter added.
+ *
+ * @param mixed $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash,
+ * user email, WP_User object, WP_Post object, or comment object.
+ * @param int $size Optional. Height and width of the avatar image file in pixels. Default 96.
+ * @param string $default Optional. URL for the default image or a default type. Accepts '404'
+ * (return a 404 instead of a default image), 'retro' (8bit), 'monsterid'
+ * (monster), 'wavatar' (cartoon face), 'indenticon' (the "quilt"),
+ * 'mystery', 'mm', or 'mysterman' (The Oyster Man), 'blank' (transparent GIF),
+ * or 'gravatar_default' (the Gravatar logo). Default is the value of the
+ * 'avatar_default' option, with a fallback of 'mystery'.
+ * @param string $alt Optional. Alternative text to use in <img> tag. Default empty.
+ * @param array $args {
+ * Optional. Extra arguments to retrieve the avatar.
+ *
+ * @type int $height Display height of the avatar in pixels. Defaults to $size.
+ * @type int $width Display width of the avatar in pixels. Defaults to $size.
+ * @type bool $force_default Whether to always show the default image, never the Gravatar. Default false.
+ * @type string $rating What rating to display avatars up to. Accepts 'G', 'PG', 'R', 'X', and are
+ * judged in that order. Default is the value of the 'avatar_rating' option.
+ * @type string $scheme URL scheme to use. See set_url_scheme() for accepted values.
+ * Default null.
+ * @type array|string $class Array or string of additional classes to add to the <img> element.
+ * Default null.
+ * @type bool $force_display Whether to always show the avatar - ignores the show_avatars option.
+ * Default false.
+ * @type string $extra_attr HTML attributes to insert in the IMG element. Is not sanitized. Default empty.
+ * }
+ * @return false|string `<img>` tag for the user's avatar. False on failure.
+ */
+function get_avatar( $id_or_email, $size = 96, $default = '', $alt = '', $args = null ) {
+ $defaults = array(
+ // get_avatar_data() args.
+ 'size' => 96,
+ 'height' => null,
+ 'width' => null,
+ 'default' => get_option( 'avatar_default', 'mystery' ),
+ 'force_default' => false,
+ 'rating' => get_option( 'avatar_rating' ),
+ 'scheme' => null,
+ 'alt' => '',
+ 'class' => null,
+ 'force_display' => false,
+ 'extra_attr' => '',
+ );
+
+ if ( empty( $args ) ) {
+ $args = array();
+ }
- if ( false === $alt)
- $safe_alt = '';
- else
- $safe_alt = esc_attr( $alt );
-
- if ( !is_numeric($size) )
- $size = '96';
-
- $email = '';
- if ( is_numeric($id_or_email) ) {
- $id = (int) $id_or_email;
- $user = get_userdata($id);
- if ( $user )
- $email = $user->user_email;
- } elseif ( is_object($id_or_email) ) {
- if ( isset($id_or_email->comment_type) && '' != $id_or_email->comment_type && 'comment' != $id_or_email->comment_type )
- return false; // No avatar for pingbacks or trackbacks
-
- if ( !empty($id_or_email->user_id) ) {
- $id = (int) $id_or_email->user_id;
- $user = get_userdata($id);
- if ( $user)
- $email = $user->user_email;
- } elseif ( !empty($id_or_email->comment_author_email) ) {
- $email = $id_or_email->comment_author_email;
- }
- } else {
- $email = $id_or_email;
+ $args['size'] = (int) $size;
+ $args['default'] = $default;
+ $args['alt'] = $alt;
+
+ $args = wp_parse_args( $args, $defaults );
+
+ if ( empty( $args['height'] ) ) {
+ $args['height'] = $args['size'];
+ }
+ if ( empty( $args['width'] ) ) {
+ $args['width'] = $args['size'];
}
- if ( empty($default) ) {
- $avatar_default = get_option('avatar_default');
- if ( empty($avatar_default) )
- $default = 'mystery';
- else
- $default = $avatar_default;
+ /**
+ * Filter whether to retrieve the avatar URL early.
+ *
+ * Passing a non-null value will effectively short-circuit get_avatar(), passing
+ * the value through the {@see 'pre_get_avatar'} filter and returning early.
+ *
+ * @since 4.2.0
+ *
+ * @param string $avatar HTML for the user's avatar. Default null.
+ * @param int|object|string $id_or_email A user ID, email address, or comment object.
+ * @param array $args Arguments passed to get_avatar_url(), after processing.
+ */
+ $avatar = apply_filters( 'pre_get_avatar', null, $id_or_email, $args );
+
+ if ( ! is_null( $avatar ) ) {
+ /** This filter is documented in wp-includes/pluggable.php */
+ return apply_filters( 'get_avatar', $avatar, $id_or_email, $args['size'], $args['default'], $args['alt'], $args );
}
- if ( is_ssl() )
- $host = 'https://secure.gravatar.com';
- else
- $host = 'http://www.gravatar.com';
-
- if ( 'mystery' == $default )
- $default = "$host/avatar/ad516503a11cd5ca435acc9bb6523536?s={$size}"; // ad516503a11cd5ca435acc9bb6523536 == md5('unknown@gravatar.com')
- elseif ( 'blank' == $default )
- $default = includes_url('images/blank.gif');
- elseif ( !empty($email) && 'gravatar_default' == $default )
- $default = '';
- elseif ( 'gravatar_default' == $default )
- $default = "$host/avatar/s={$size}";
- elseif ( empty($email) )
- $default = "$host/avatar/?d=$default&s={$size}";
- elseif ( strpos($default, 'http://') === 0 )
- $default = add_query_arg( 's', $size, $default );
-
- if ( !empty($email) ) {
- $out = "$host/avatar/";
- $out .= md5( strtolower( $email ) );
- $out .= '?s='.$size;
- $out .= '&d=' . urlencode( $default );
-
- $rating = get_option('avatar_rating');
- if ( !empty( $rating ) )
- $out .= "&r={$rating}";
-
- $avatar = "<img alt='{$safe_alt}' src='{$out}' class='avatar avatar-{$size} photo' height='{$size}' width='{$size}' />";
- } else {
- $avatar = "<img alt='{$safe_alt}' src='{$default}' class='avatar avatar-{$size} photo avatar-default' height='{$size}' width='{$size}' />";
+ if ( ! $args['force_display'] && ! get_option( 'show_avatars' ) ) {
+ return false;
}
- return apply_filters('get_avatar', $avatar, $id_or_email, $size, $default, $alt);
-}
-endif;
+ $url2x = get_avatar_url( $id_or_email, array_merge( $args, array( 'size' => $args['size'] * 2 ) ) );
-if ( !function_exists('wp_setcookie') ) :
-/**
- * Sets a cookie for a user who just logged in.
- *
- * @since 1.5
- * @deprecated Use wp_set_auth_cookie()
- * @see wp_set_auth_cookie()
- *
- * @param string $username The user's username
- * @param string $password Optional. The user's password
- * @param bool $already_md5 Optional. Whether the password has already been through MD5
- * @param string $home Optional. Will be used instead of COOKIEPATH if set
- * @param string $siteurl Optional. Will be used instead of SITECOOKIEPATH if set
- * @param bool $remember Optional. Remember that the user is logged in
- */
-function wp_setcookie($username, $password = '', $already_md5 = false, $home = '', $siteurl = '', $remember = false) {
- _deprecated_function( __FUNCTION__, '2.5', 'wp_set_auth_cookie()' );
- $user = get_userdatabylogin($username);
- wp_set_auth_cookie($user->ID, $remember);
-}
-endif;
+ $args = get_avatar_data( $id_or_email, $args );
-if ( !function_exists('wp_clearcookie') ) :
-/**
- * Clears the authentication cookie, logging the user out.
- *
- * @since 1.5
- * @deprecated Use wp_clear_auth_cookie()
- * @see wp_clear_auth_cookie()
- */
-function wp_clearcookie() {
- _deprecated_function( __FUNCTION__, '2.5', 'wp_clear_auth_cookie()' );
- wp_clear_auth_cookie();
-}
-endif;
+ $url = $args['url'];
-if ( !function_exists('wp_get_cookie_login') ):
-/**
- * Gets the user cookie login.
- *
- * This function is deprecated and should no longer be extended as it won't be
- * used anywhere in WordPress. Also, plugins shouldn't use it either.
- *
- * @since 2.0.3
- * @deprecated No alternative
- *
- * @return bool Always returns false
- */
-function wp_get_cookie_login() {
- _deprecated_function( __FUNCTION__, '2.5', '' );
- return false;
-}
-endif;
+ if ( ! $url || is_wp_error( $url ) ) {
+ return false;
+ }
-if ( !function_exists('wp_login') ) :
-/**
- * Checks a users login information and logs them in if it checks out.
- *
- * Use the global $error to get the reason why the login failed. If the username
- * is blank, no error will be set, so assume blank username on that case.
- *
- * Plugins extending this function should also provide the global $error and set
- * what the error is, so that those checking the global for why there was a
- * failure can utilize it later.
- *
- * @since 1.2.2
- * @deprecated Use wp_signon()
- * @global string $error Error when false is returned
- *
- * @param string $username User's username
- * @param string $password User's password
- * @param bool $deprecated Not used
- * @return bool False on login failure, true on successful check
- */
-function wp_login($username, $password, $deprecated = '') {
- global $error;
+ $class = array( 'avatar', 'avatar-' . (int) $args['size'], 'photo' );
- $user = wp_authenticate($username, $password);
+ if ( ! $args['found_avatar'] || $args['force_default'] ) {
+ $class[] = 'avatar-default';
+ }
- if ( ! is_wp_error($user) )
- return true;
+ if ( $args['class'] ) {
+ if ( is_array( $args['class'] ) ) {
+ $class = array_merge( $class, $args['class'] );
+ } else {
+ $class[] = $args['class'];
+ }
+ }
- $error = $user->get_error_message();
- return false;
+ $avatar = sprintf(
+ "<img alt='%s' src='%s' srcset='%s' class='%s' height='%d' width='%d' %s/>",
+ esc_attr( $args['alt'] ),
+ esc_url( $url ),
+ esc_attr( "$url2x 2x" ),
+ esc_attr( join( ' ', $class ) ),
+ (int) $args['height'],
+ (int) $args['width'],
+ $args['extra_attr']
+ );
+
+ /**
+ * Filter the avatar to retrieve.
+ *
+ * @since 2.5.0
+ * @since 4.2.0 The `$args` parameter was added.
+ *
+ * @param string $avatar <img> tag for the user's avatar.
+ * @param int|object|string $id_or_email A user ID, email address, or comment object.
+ * @param int $size Square avatar width and height in pixels to retrieve.
+ * @param string $alt Alternative text to use in the avatar image tag.
+ * Default empty.
+ * @param array $args Arguments passed to get_avatar_data(), after processing.
+ */
+ return apply_filters( 'get_avatar', $avatar, $id_or_email, $args['size'], $args['default'], $args['alt'], $args );
}
endif;
* 'title_right' : Default is an empty string. Change the HTML to the right of
* the title.
*
- * @since 2.6
+ * @since 2.6.0
+ *
* @see wp_parse_args() Used to change defaults to user defined settings.
* @uses Text_Diff
* @uses WP_Text_Diff_Renderer_Table
*
- * @param string $left_string "old" (left) version of string
- * @param string $right_string "new" (right) version of string
- * @param string|array $args Optional. Change 'title', 'title_left', and 'title_right' defaults.
+ * @param string $left_string "old" (left) version of string
+ * @param string $right_string "new" (right) version of string
+ * @param string|array $args Optional. Change 'title', 'title_left', and 'title_right' defaults.
* @return string Empty string if strings are equivalent or HTML with differences.
*/
function wp_text_diff( $left_string, $right_string, $args = null ) {
$left_string = normalize_whitespace($left_string);
$right_string = normalize_whitespace($right_string);
- $left_lines = split("\n", $left_string);
- $right_lines = split("\n", $right_string);
-
+ $left_lines = explode("\n", $left_string);
+ $right_lines = explode("\n", $right_string);
$text_diff = new Text_Diff($left_lines, $right_lines);
- $renderer = new WP_Text_Diff_Renderer_Table();
+ $renderer = new WP_Text_Diff_Renderer_Table( $args );
$diff = $renderer->render($text_diff);
if ( !$diff )
return '';
$r = "<table class='diff'>\n";
- $r .= "<col class='ltype' /><col class='content' /><col class='ltype' /><col class='content' />";
+
+ if ( ! empty( $args[ 'show_split_view' ] ) ) {
+ $r .= "<col class='content diffsplit left' /><col class='content diffsplit middle' /><col class='content diffsplit right' />";
+ } else {
+ $r .= "<col class='content' />";
+ }
if ( $args['title'] || $args['title_left'] || $args['title_right'] )
$r .= "<thead>";
}
endif;
-?>
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff