*
* The default content type is 'text/plain' which does not allow using HTML.
* However, you can set the content type of the email by using the
- * 'wp_mail_content_type' filter.
+ * {@see 'wp_mail_content_type'} filter.
*
* The default charset is based on the charset used on the blog. The charset can
- * be set using the 'wp_mail_charset' filter.
+ * be set using the {@see 'wp_mail_charset'} filter.
*
* @since 1.2.1
*
// Compact the input, apply the filters, and extract them back out
/**
- * Filter the wp_mail() arguments.
+ * Filters the wp_mail() arguments.
*
* @since 2.2.0
*
}
// Headers
+ $cc = $bcc = $reply_to = array();
+
if ( empty( $headers ) ) {
$headers = array();
} else {
$tempheaders = $headers;
}
$headers = array();
- $cc = array();
- $bcc = array();
// If it's actually got contents
if ( !empty( $tempheaders ) ) {
case 'bcc':
$bcc = array_merge( (array) $bcc, explode( ',', $content ) );
break;
+ case 'reply-to':
+ $reply_to = array_merge( (array) $reply_to, explode( ',', $content ) );
+ break;
default:
// Add it to our grand headers array
$headers[trim( $name )] = trim( $content );
}
/**
- * Filter the email address to send from.
+ * Filters 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 );
+ $from_email = apply_filters( 'wp_mail_from', $from_email );
/**
- * Filter the name to associate with the "from" email address.
+ * Filters 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 );
+ $from_name = apply_filters( 'wp_mail_from_name', $from_name );
+
+ $phpmailer->setFrom( $from_email, $from_name, false );
// 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;
- // Add any CC and BCC recipients
- if ( !empty( $cc ) ) {
- foreach ( (array) $cc 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->AddCc( $recipient, $recipient_name );
- } catch ( phpmailerException $e ) {
- continue;
- }
+ // Use appropriate methods for handling addresses, rather than treating them as generic headers
+ $address_headers = compact( 'to', 'cc', 'bcc', 'reply_to' );
+
+ foreach ( $address_headers as $address_header => $addresses ) {
+ if ( empty( $addresses ) ) {
+ continue;
}
- }
- if ( !empty( $bcc ) ) {
- foreach ( (array) $bcc as $recipient) {
+ foreach ( (array) $addresses as $address ) {
try {
// Break $recipient into name and address parts if in the format "Foo <bar@baz.com>"
$recipient_name = '';
- if ( preg_match( '/(.*)<(.+)>/', $recipient, $matches ) ) {
+
+ if ( preg_match( '/(.*)<(.+)>/', $address, $matches ) ) {
if ( count( $matches ) == 3 ) {
$recipient_name = $matches[1];
- $recipient = $matches[2];
+ $address = $matches[2];
}
}
- $phpmailer->AddBcc( $recipient, $recipient_name );
+
+ switch ( $address_header ) {
+ case 'to':
+ $phpmailer->addAddress( $address, $recipient_name );
+ break;
+ case 'cc':
+ $phpmailer->addCc( $address, $recipient_name );
+ break;
+ case 'bcc':
+ $phpmailer->addBcc( $address, $recipient_name );
+ break;
+ case 'reply_to':
+ $phpmailer->addReplyTo( $address, $recipient_name );
+ break;
+ }
} catch ( phpmailerException $e ) {
continue;
}
$content_type = 'text/plain';
/**
- * Filter the wp_mail() content type.
+ * Filters the wp_mail() content type.
*
* @since 2.3.0
*
// Set the content-type and charset
/**
- * Filter the default wp_mail() charset.
+ * Filters the default wp_mail() charset.
*
* @since 2.3.0
*
$password = trim($password);
/**
- * Filter whether a set of user login credentials are valid.
+ * Filters whether a set of user login credentials are valid.
*
* A WP_User object is returned if the credentials authenticate a user.
* WP_Error or null otherwise.
$token = $cookie_elements['token'];
$expired = $expiration = $cookie_elements['expiration'];
- // Allow a grace period for POST and AJAX requests
+ // Allow a grace period for POST and Ajax requests
if ( defined('DOING_AJAX') || 'POST' == $_SERVER['REQUEST_METHOD'] ) {
$expired += HOUR_IN_SECONDS;
}
return false;
}
- // AJAX/POST grace period set above
+ // Ajax/POST grace period set above
if ( $expiration < time() ) {
$GLOBALS['login_grace_period'] = 1;
}
* @since 2.5.0
*
* @param int $user_id User ID
- * @param int $expiration Cookie expiration in seconds
+ * @param int $expiration The time the cookie expires as a UNIX timestamp.
* @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.
$cookie = $user->user_login . '|' . $expiration . '|' . $token . '|' . $hash;
/**
- * Filter the authentication cookie.
+ * Filters 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 int $expiration The time the cookie expires as a UNIX timestamp.
* @param string $scheme Cookie scheme used. Accepts 'auth', 'secure_auth', or 'logged_in'.
* @param string $token User's session token used.
*/
function wp_set_auth_cookie( $user_id, $remember = false, $secure = '', $token = '' ) {
if ( $remember ) {
/**
- * Filter the duration of the authentication cookie expiration period.
+ * Filters the duration of the authentication cookie expiration period.
*
* @since 2.8.0
*
$secure_logged_in_cookie = $secure && 'https' === parse_url( get_option( 'home' ), PHP_URL_SCHEME );
/**
- * Filter whether the connection is secure.
+ * Filters whether the connection is secure.
*
* @since 3.1.0
*
$secure = apply_filters( 'secure_auth_cookie', $secure, $user_id );
/**
- * Filter whether to use a secure cookie when logged-in.
+ * Filters whether to use a secure cookie when logged-in.
*
* @since 3.1.0
*
* @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 $expire The time the login grace period expires as a UNIX timestamp.
+ * Default is 12 hours past the cookie's expiration time.
+ * @param int $expiration The time when the authentication cookie expires as a UNIX timestamp.
+ * Default is 14 days from now.
* @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.
+ * Fires immediately before the logged-in 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 $expire The time the login grace period expires as a UNIX timestamp.
+ * Default is 12 hours past the cookie's expiration time.
+ * @param int $expiration The time when the logged-in authentication cookie expires as a UNIX timestamp.
+ * Default is 14 days from now.
* @param int $user_id User ID.
* @param string $scheme Authentication scheme. Default 'logged_in'.
*/
$secure = ( is_ssl() || force_ssl_admin() );
/**
- * Filter whether to use a secure authentication redirect.
+ * Filters whether to use a secure authentication redirect.
*
* @since 3.1.0
*
*/
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' );
+ _doing_it_wrong( __FUNCTION__, __( 'You should specify a nonce action to be verified by using the first parameter.' ), '3.2.0' );
$adminurl = strtolower(admin_url());
$referer = strtolower(wp_get_referer());
if ( !function_exists('check_ajax_referer') ) :
/**
- * Verifies the AJAX request to prevent processing requests external of the blog.
+ * Verifies the Ajax request to prevent processing requests external of the blog.
*
* @since 2.0.3
*
$result = wp_verify_nonce( $nonce, $action );
/**
- * Fires once the AJAX request has been validated or not.
+ * Fires once the Ajax request has been validated or not.
*
* @since 2.1.0
*
- * @param string $action The AJAX nonce action.
+ * @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.
*/
/**
* Redirects to another page.
*
+ * Note: wp_redirect() does not exit automatically, and should almost always be
+ * followed by a call to `exit;`:
+ *
+ * wp_redirect( $url );
+ * exit;
+ *
+ * Exiting can also be selectively manipulated by using wp_redirect() as a conditional
+ * in conjunction with the {@see 'wp_redirect'} and {@see 'wp_redirect_location'} hooks:
+ *
+ * if ( wp_redirect( $url ) {
+ * exit;
+ * }
+ *
* @since 1.5.1
*
* @global bool $is_IIS
global $is_IIS;
/**
- * Filter the redirect location.
+ * Filters the redirect location.
*
* @since 2.1.0
*
$location = apply_filters( 'wp_redirect', $location, $status );
/**
- * Filter the redirect status code.
+ * Filters the redirect status code.
*
* @since 2.3.0
*
$location = wp_sanitize_redirect($location);
/**
- * Filter the redirect fallback URL for when the provided redirect is not safe (local).
+ * Filters the redirect fallback URL for when the provided redirect is not safe (local).
*
* @since 4.3.0
*
$wpp = parse_url(home_url());
/**
- * Filter the whitelist of hosts to redirect to.
+ * Filters the whitelist of hosts to redirect to.
*
* @since 2.3.0
*
*/
function wp_notify_postauthor( $comment_id, $deprecated = null ) {
if ( null !== $deprecated ) {
- _deprecated_argument( __FUNCTION__, '3.8' );
+ _deprecated_argument( __FUNCTION__, '3.8.0' );
}
$comment = get_comment( $comment_id );
}
/**
- * Filter the list of email addresses to receive a comment notification.
+ * Filters 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.
$emails = array_flip( $emails );
/**
- * Filter whether to notify comment authors of their comments on their own posts.
+ * Filters 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.
$message_headers .= $reply_to . "\n";
/**
- * Filter the comment notification email text.
+ * Filters the comment notification email text.
*
* @since 1.5.2
*
$notify_message = apply_filters( 'comment_notification_text', $notify_message, $comment->comment_ID );
/**
- * Filter the comment notification email subject.
+ * Filters the comment notification email subject.
*
* @since 1.5.2
*
$subject = apply_filters( 'comment_notification_subject', $subject, $comment->comment_ID );
/**
- * Filter the comment notification email headers.
+ * Filters the comment notification email headers.
*
* @since 1.5.2
*
$maybe_notify = get_option( 'moderation_notify' );
/**
- * Filter whether to send the site moderator email notifications, overriding the site setting.
+ * Filters whether to send the site moderator email notifications, overriding the site setting.
*
* @since 4.4.0
*
$message_headers = '';
/**
- * Filter the list of recipients for comment moderation emails.
+ * Filters the list of recipients for comment moderation emails.
*
* @since 3.7.0
*
$emails = apply_filters( 'comment_moderation_recipients', $emails, $comment_id );
/**
- * Filter the comment moderation email text.
+ * Filters the comment moderation email text.
*
* @since 1.5.2
*
$notify_message = apply_filters( 'comment_moderation_text', $notify_message, $comment_id );
/**
- * Filter the comment moderation email subject.
+ * Filters the comment moderation email subject.
*
* @since 1.5.2
*
$subject = apply_filters( 'comment_moderation_subject', $subject, $comment_id );
/**
- * Filter the comment moderation email headers.
+ * Filters the comment moderation email headers.
*
* @since 2.8.0
*
// 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 ( 0 !== strcasecmp( $user->user_email, get_option( 'admin_email' ) ) ) {
- $message = sprintf(__('Password Lost and Changed for user: %s'), $user->user_login) . "\r\n";
+ /* translators: %s: user name */
+ $message = sprintf( __( 'Password changed for user: %s' ), $user->user_login ) . "\r\n";
// 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);
+ /* translators: %s: site title */
+ wp_mail( get_option( 'admin_email' ), sprintf( __( '[%s] Password Changed' ), $blogname ), $message );
}
}
endif;
* @since 2.0.0
* @since 4.3.0 The `$plaintext_pass` parameter was changed to `$notify`.
* @since 4.3.1 The `$plaintext_pass` parameter was deprecated. `$notify` added as a third parameter.
+ * @since 4.6.0 The `$notify` parameter accepts 'user' for sending notification only to the user created.
*
* @global wpdb $wpdb WordPress database object for queries.
* @global PasswordHash $wp_hasher Portable PHP password hashing framework instance.
* @param int $user_id User ID.
* @param null $deprecated Not used (argument deprecated).
* @param string $notify Optional. Type of notification that should happen. Accepts 'admin' or an empty
- * string (admin only), or 'both' (admin and user). Default empty.
+ * string (admin only), 'user', or 'both' (admin and user). Default empty.
*/
function wp_new_user_notification( $user_id, $deprecated = null, $notify = '' ) {
if ( $deprecated !== null ) {
// 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 site %s:'), $blogname) . "\r\n\r\n";
- $message .= sprintf(__('Username: %s'), $user->user_login) . "\r\n\r\n";
- $message .= sprintf(__('Email: %s'), $user->user_email) . "\r\n";
+ if ( 'user' !== $notify ) {
+ $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( __( 'Email: %s' ), $user->user_email ) . "\r\n";
- @wp_mail(get_option('admin_email'), sprintf(__('[%s] New User Registration'), $blogname), $message);
+ @wp_mail( get_option( 'admin_email' ), sprintf( __( '[%s] New User Registration' ), $blogname ), $message );
+ }
// `$deprecated was pre-4.3 `$plaintext_pass`. An empty `$plaintext_pass` didn't sent a user notifcation.
if ( 'admin' === $notify || ( empty( $deprecated ) && empty( $notify ) ) ) {
*/
function wp_nonce_tick() {
/**
- * Filter the lifespan of nonces in seconds.
+ * Filters the lifespan of nonces in seconds.
*
* @since 2.5.0
*
$uid = (int) $user->ID;
if ( ! $uid ) {
/**
- * Filter whether the user who generated the nonce is logged out.
+ * Filters whether the user who generated the nonce is logged out.
*
* @since 3.5.0
*
static $cached_salts = array();
if ( isset( $cached_salts[ $scheme ] ) ) {
/**
- * Filter the WordPress salt.
+ * Filters the WordPress salt.
*
* @since 2.5.0
*
}
/**
- * Filter whether the plaintext password matches the encrypted password.
+ * Filters whether the plaintext password matches the encrypted password.
*
* @since 2.5.0
*
}
/**
- * Filter the randomly-generated password.
+ * Filters the randomly-generated password.
*
* @since 3.0.0
*
}
/**
- * Filter whether to retrieve the avatar URL early.
+ * Filters whether to retrieve the avatar URL early.
*
* Passing a non-null value will effectively short-circuit get_avatar(), passing
* the value through the {@see 'get_avatar'} filter and returning early.
);
/**
- * Filter the avatar to retrieve.
+ * Filters the avatar to retrieve.
*
* @since 2.5.0
* @since 4.2.0 The `$args` parameter was added.
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff