Index: src/wp-includes/pluggable.php =================================================================== --- src/wp-includes/pluggable.php (revision 27728) +++ src/wp-includes/pluggable.php (working copy) @@ -18,7 +18,6 @@ * * @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. * * @param int $id User ID * @param string $name User's username @@ -34,7 +33,12 @@ 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; } @@ -204,13 +208,7 @@ * 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|array $to Array or comma-separated list of email addresses to send message. @@ -222,6 +220,14 @@ */ function wp_mail( $to, $subject, $message, $headers = '', $attachments = array() ) { // Compact the input, apply the filters, and extract them back out + /** + * 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. + */ extract( apply_filters( 'wp_mail', compact( 'to', 'subject', 'message', 'headers', 'attachments' ) ) ); if ( !is_array($attachments) ) @@ -342,8 +348,22 @@ $from_email = 'wordpress@' . $sitename; } - // Plugin authors can override the potentially troublesome default - $phpmailer->From = apply_filters( 'wp_mail_from' , $from_email ); + /** + * 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 addresses @@ -415,6 +435,13 @@ 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; @@ -428,6 +455,14 @@ $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 @@ -450,6 +485,13 @@ } } + /** + * 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! @@ -475,6 +517,18 @@ $username = sanitize_user($username); $password = trim($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 ) { @@ -486,7 +540,14 @@ $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 as failed. + * + * @since 2.5.0 + * + * @param string $username User login. + */ + do_action( 'wp_login_failed', $username ); } return $user; @@ -501,7 +562,13 @@ */ function wp_logout() { wp_clear_auth_cookie(); - do_action('wp_logout'); + + /** + * Fires after a user is logged-out. + * + * @since 1.5.0 + */ + do_action( 'wp_logout' ); } endif; @@ -523,7 +590,16 @@ */ 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; } @@ -537,13 +613,27 @@ // 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 Array of data for the authentication cookie. + */ + do_action( 'auth_cookie_expired', $cookie_elements ); return false; } $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 Array of data for the authentication cookie. + */ + do_action( 'auth_cookie_bad_username', $cookie_elements ); return false; } @@ -553,14 +643,29 @@ $hash = hash_hmac('md5', $username . '|' . $expiration, $key); if ( $hmac != $hash ) { - do_action('auth_cookie_bad_hash', $cookie_elements); + /** + * Fires if a bad authentication cookie hash is encountered. + * + * @since 2.7.0 + * + * @param array $cookie_elements Array of data for the authentication cookie. + */ + do_action( 'auth_cookie_bad_hash', $cookie_elements ); return false; } if ( $expiration < time() ) // AJAX/POST grace period set above $GLOBALS['login_grace_period'] = 1; - do_action('auth_cookie_valid', $cookie_elements, $user); + /** + * Fires once an authentication cookie has been validated. + * + * @since 2.7.0 + * + * @param array $cookie_elements Array of data for the authentication cookie. + * @param WP_User $user User object. + */ + do_action( 'auth_cookie_valid', $cookie_elements, $user ); return $user->ID; } @@ -572,9 +677,6 @@ * * @since 2.5.0 * - * @uses apply_filters() Calls 'auth_cookie' hook on $cookie contents, User ID - * and expiration of 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 @@ -590,7 +692,17 @@ $cookie = $user->user_login . '|' . $expiration . '|' . $hash; - return apply_filters('auth_cookie', $cookie, $user_id, $expiration, $scheme); + /** + * 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'. + */ + return apply_filters( 'auth_cookie', $cookie, $user_id, $expiration, $scheme ); } endif; @@ -656,21 +768,54 @@ */ function wp_set_auth_cookie($user_id, $remember = false, $secure = '') { if ( $remember ) { - $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(). + /** + * Filter the length of the authentication cookie expiration period. + * + * @since 2.8.0 + * + * @param int $length Length 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', 2 * DAY_IN_SECONDS, $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(); - $secure = apply_filters('secure_auth_cookie', $secure, $user_id); - $secure_logged_in_cookie = apply_filters('secure_logged_in_cookie', false, $user_id, $secure); + /** + * Filter whether to use a secure authentication cookie. + * + * @since 3.1.0 + * + * @param bool $secure Whether to use a secure auth cookie. Default is value of is_ssl + * or false. + * @param int $user_id User ID. + */ + $secure = apply_filters( 'secure_auth_cookie', $secure, $user_id ); + /** + * Filter the secure logged-in cookie. + * + * @since 3.1.0 + * + * @param bool|string $cookie The secure logged-in cookie. Default false. + * @param int $user_id User ID. + * @param bool $secure Whether to use a secure auth cookie. Default is value + * of is_ssl() or false. + */ + $secure_logged_in_cookie = apply_filters( 'secure_logged_in_cookie', false, $user_id, $secure ); + if ( $secure ) { $auth_cookie_name = SECURE_AUTH_COOKIE; $scheme = 'secure_auth'; @@ -682,9 +827,34 @@ $auth_cookie = wp_generate_auth_cookie($user_id, $expiration, $scheme); $logged_in_cookie = wp_generate_auth_cookie($user_id, $expiration, 'logged_in'); - 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'); + /** + * 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 immediate 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' ); + 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); @@ -700,7 +870,12 @@ * @since 2.5.0 */ function wp_clear_auth_cookie() { - do_action('clear_auth_cookie'); + /** + * Fires just before the authentication cookie is cleared. + * + * @since 2.7.0 + */ + do_action( 'clear_auth_cookie' ); 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 ); @@ -752,7 +927,14 @@ $secure = ( is_ssl() || force_ssl_admin() ); - $secure = apply_filters('secure_auth_redirect', $secure); + /** + * 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') ) { @@ -765,13 +947,28 @@ } } - if ( is_user_admin() ) + if ( is_user_admin() ) { $scheme = 'logged_in'; - else + } else { + /** + * Filter the authentication redirect scheme. + * + * @since 2.9.0 + * + * @param string $scheme Autentication redirect scheme. Default empty. + */ $scheme = apply_filters( 'auth_redirect_scheme', '' ); + } if ( $user_id = wp_validate_auth_cookie( '', $scheme) ) { - do_action('auth_redirect', $user_id); + /** + * 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') ) { @@ -806,7 +1003,6 @@ * 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) @@ -822,7 +1018,16 @@ wp_nonce_ays($action); die(); } - do_action('check_admin_referer', $action, $result); + + /** + * Fires once the admin request has been validated or not. + * + * @since 1.5.1 + * + * @param string $action The nonce action. + * @param bool $result Whether the admin request nonce was validated. + */ + do_action( 'check_admin_referer', $action, $result ); return $result; } endif; @@ -855,7 +1060,15 @@ 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 bool $result Whether the AJAX request nonce was validated. + */ + do_action( 'check_ajax_referer', $action, $result ); return $result; } @@ -866,7 +1079,6 @@ * Redirects to another page. * * @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. @@ -968,8 +1180,6 @@ * 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 if $location is not allowed @@ -1000,7 +1210,15 @@ $wpp = parse_url(home_url()); - $allowed_hosts = (array) apply_filters('allowed_redirect_hosts', array($wpp['host']), isset($lp['host']) ? $lp['host'] : ''); + /** + * Filter the list of hosts allowed to be redirected to. + * + * @since 2.3.0 + * + * @param array $hosts 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; @@ -1163,10 +1381,36 @@ 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 ); + foreach ( $emails as $email ) { @wp_mail( $email, $subject, $notify_message, $message_headers ); } @@ -1249,11 +1493,46 @@ $subject = sprintf( __('[%1$s] Please moderate: "%2$s"'), $blogname, $post->post_title ); $message_headers = ''; - $emails = apply_filters( 'comment_moderation_recipients', $emails, $comment_id ); - $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, $comment_id ); + /** + * 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 ); + foreach ( $emails as $email ) { @wp_mail( $email, $subject, $notify_message, $message_headers ); } @@ -1331,6 +1610,13 @@ * @return int */ function wp_nonce_tick() { + /** + * 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 )); @@ -1353,8 +1639,17 @@ function wp_verify_nonce($nonce, $action = -1) { $user = wp_get_current_user(); $uid = (int) $user->ID; - if ( ! $uid ) + 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 ); + } $i = wp_nonce_tick(); @@ -1381,8 +1676,10 @@ function wp_create_nonce($action = -1) { $user = wp_get_current_user(); $uid = (int) $user->ID; - if ( ! $uid ) + if ( ! $uid ) { + /** This filter is documented in wp-includes/pluggable.php */ $uid = apply_filters( 'nonce_user_logged_out', $uid, $action ); + } $i = wp_nonce_tick(); @@ -1427,8 +1724,18 @@ */ function wp_salt( $scheme = 'auth' ) { static $cached_salts = array(); - if ( isset( $cached_salts[ $scheme ] ) ) + if ( isset( $cached_salts[ $scheme ] ) ) { + /** + * Filter the WP 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 ); + } static $duplicated_keys; if ( null === $duplicated_keys ) { @@ -1474,6 +1781,8 @@ } $cached_salts[ $scheme ] = $key . $salt; + + /** This filter is documented in wp-includes/pluggable.php */ return apply_filters( 'salt', $cached_salts[ $scheme ], $scheme ); } endif; @@ -1557,7 +1866,16 @@ $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 $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 @@ -1570,6 +1888,7 @@ $check = $wp_hasher->CheckPassword($password, $hash); + /** This filter is documented in wp-includes/pluggable.php */ return apply_filters('check_password', $check, $password, $hash, $user_id); } endif; @@ -1598,8 +1917,14 @@ $password .= substr($chars, wp_rand(0, strlen($chars) - 1), 1); } - // random_password filter was previously in random_password function which was deprecated - return apply_filters('random_password', $password); + /** + * Filter the randomly-generated password. + * + * @since 3.0.0 + * + * @param string $password The generated password. + */ + return apply_filters( 'random_password', $password ); } endif; @@ -1707,6 +2032,14 @@ $email = $user->user_email; } elseif ( is_object($id_or_email) ) { // No avatar for pingbacks or trackbacks + + /** + * Filter the list of allowed comment types for retrieving avatars. + * + * @since 3.0.0 + * + * @param array $types Array of content types. Default only contains 'comment'. + */ $allowed_comment_types = apply_filters( 'get_avatar_comment_types', array( 'comment' ) ); if ( ! empty( $id_or_email->comment_type ) && ! in_array( $id_or_email->comment_type, (array) $allowed_comment_types ) ) return false; @@ -1773,7 +2106,17 @@ $avatar = "{$safe_alt}"; } - return apply_filters('get_avatar', $avatar, $id_or_email, $size, $default, $alt); + /** + * Filter the avatar to retrieve. + * + * @since 2.5.0 + * + * @param string $avatar 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. Defaults empty. + */ + return apply_filters( 'get_avatar', $avatar, $id_or_email, $size, $default, $alt ); } endif;