* 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.
+ * @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
*/
*
* @since 2.0.3
*
+ * @global WP_User $current_user
+ *
* @return WP_User Current user WP_User object
*/
function wp_get_current_user() {
*
* @since 0.71
*
- * @uses $current_user Checks if the current user is set
+ * @global WP_User $current_user Checks if the current user is set
*
- * @return null|false False on XML-RPC Request and invalid auth cookie. Null when current user set.
+ * @return false|void False on XML-RPC Request and invalid auth cookie.
*/
function get_currentuserinfo() {
global $current_user;
* @since 0.71
*
* @param int $user_id User ID
- * @return WP_User|bool WP_User object on success, false on failure.
+ * @return WP_User|false WP_User object on success, false on failure.
*/
function get_userdata( $user_id ) {
return get_user_by( 'id', $user_id );
*
* @since 2.8.0
*
- * @param string $field The field to retrieve the user with. id | slug | email | login
+ * @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|bool WP_User object on success, false on failure.
+ * @return WP_User|false WP_User object on success, false on failure.
*/
function get_user_by( $field, $value ) {
$userdata = WP_User::get_data_by( $field, $value );
*
* @since 3.0.0
*
+ * @global wpdb $wpdb
+ *
* @param array $user_ids User ID numbers list
*/
function cache_users( $user_ids ) {
*
* @since 1.2.1
*
- * @uses PHPMailer
+ * @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 $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.
*/
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( '/(.*)<(.+)>/', $recipient, $matches ) ) {
if ( count( $matches ) == 3 ) {
$recipient_name = $matches[1];
$recipient = $matches[2];
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( '/(.*)<(.+)>/', $recipient, $matches ) ) {
if ( count( $matches ) == 3 ) {
$recipient_name = $matches[1];
$recipient = $matches[2];
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( '/(.*)<(.+)>/', $recipient, $matches ) ) {
if ( count( $matches ) == 3 ) {
$recipient_name = $matches[1];
$recipient = $matches[2];
*
* @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) ) {
*
* @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
- * @param string $token User's session token to use for this cookie
+ * @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', $token = '' ) {
*
* @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) ) {
* set, the cookies will be kept for 14 days or two weeks.
*
* @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
- * @param mixed $secure Whether the admin cookies should only be sent over HTTPS.
- * Default is_ssl().
+ * @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 ) {
/**
* Filter the duration of the authentication cookie expiration period.
$scheme = 'auth';
}
- $manager = WP_Session_Tokens::get_instance( $user_id );
- $token = $manager->create( $expiration );
+ if ( '' === $token ) {
+ $manager = WP_Session_Tokens::get_instance( $user_id );
+ $token = $manager->create( $expiration );
+ }
$auth_cookie = wp_generate_auth_cookie( $user_id, $expiration, $scheme, $token );
$logged_in_cookie = wp_generate_auth_cookie( $user_id, $expiration, 'logged_in', $token );
function is_user_logged_in() {
$user = wp_get_current_user();
- if ( ! $user->exists() )
- return false;
-
- return true;
+ return $user->exists();
}
endif;
$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) === 0) ) {
- wp_nonce_ays($action);
- die();
- }
/**
* Fires once the admin request has been validated or not.
* 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();
+ }
+
return $result;
}
endif;
$result = wp_verify_nonce( $nonce, $action );
- if ( $die && false == $result ) {
+ if ( $die && false === $result ) {
if ( defined( 'DOING_AJAX' ) && DOING_AJAX )
wp_die( -1 );
else
*
* @since 1.5.1
*
+ * @global bool $is_IIS
+ *
* @param string $location The path to redirect to.
- * @param int $status Status code to use.
+ * @param int $status Status code to use.
* @return bool False if $location is not provided, true otherwise.
*/
function wp_redirect($location, $status = 302) {
// remove %0d and %0a from location
$strip = array('%0d', '%0a', '%0D', '%0A');
- $location = _deep_replace($strip, $location);
- return $location;
+ return _deep_replace( $strip, $location );
}
/**
* 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.0
- *
- * @return void Does not return anything
- **/
+ */
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);
}
* @since 2.8.1
*
* @param string $location The redirect to validate
- * @param string $default The value to return if $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 = '') {
*
* @since 1.0.0
*
- * @param int $comment_id Comment ID
+ * @param int $comment_id Comment ID
* @param string $deprecated Not used
* @return bool True on completion. False if no email addresses were specified.
*/
$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: %s' ), "http://whois.arin.net/rest/ip/{$comment->comment_author_IP}" ) . "\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 */
* @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;
$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_can( $user->ID, 'edit_comment', $comment_id ) && ! empty( $user->user_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;
}
$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: %s' ), "http://whois.arin.net/rest/ip/{$comment->comment_author_IP}" ) . "\r\n";
$notify_message .= sprintf( __( 'Comment: %s' ), "\r\n" . $comment->comment_content ) . "\r\n\r\n";
break;
}
* A new user registration notification is also sent to admin email.
*
* @since 2.0.0
+ * @since 4.3.0 The `$plaintext_pass` parameter was changed to `$notify`.
*
- * @param int $user_id User ID.
- * @param string $plaintext_pass Optional. The user's plaintext password. Default empty.
+ * @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 = '') {
+function wp_new_user_notification( $user_id, $notify = '' ) {
+ global $wpdb;
$user = get_userdata( $user_id );
// The blogname option is escaped with esc_html on the way into the database in sanitize_option
@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->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 );
- wp_mail($user->user_email, sprintf(__('[%s] Your username and password'), $blogname), $message);
+ /** This action is documented in wp-login.php */
+ do_action( 'retrieve_password_key', $user->user_login, $key );
+ // 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;
*
* @link https://api.wordpress.org/secret-key/1.1/salt/ Create secrets for wp-config.php
*
+ * @staticvar array $cached_salts
+ * @staticvar array $duplicated_keys
+ *
* @param string $scheme Authentication scheme (auth, secure_auth, logged_in, nonce)
* @return string Salt value
*/
*
* @since 2.5.0
*
- * @global object $wp_hasher PHPass object
- * @uses PasswordHash::HashPassword
+ * @global PasswordHash $wp_hasher PHPass object
*
* @param string $password Plain text user password to hash
* @return string The hash string of the password
*
* @since 2.5.0
*
- * @global object $wp_hasher PHPass object used for checking the password
+ * @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 = '') {
*
* @since 2.6.2
*
+ * @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
$rnd_value .= sha1($rnd_value);
$rnd_value .= sha1($rnd_value . $seed);
$seed = md5($seed . $rnd_value);
- if ( ! defined( 'WP_SETUP_CONFIG' ) )
- 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
* @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;
$url = $args['url'];
if ( ! $url || is_wp_error( $url ) ) {
- return false;
+ return false;
}
$class = array( 'avatar', 'avatar-' . (int) $args['size'], 'photo' );
if ( ! $args['found_avatar'] || $args['force_default'] ) {
- $class[] = 'avatar-default';
+ $class[] = 'avatar-default';
}
if ( $args['class'] ) {
* @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 ) {