WordPress.org

Make WordPress Core

Changeset 28007


Ignore:
Timestamp:
04/07/2014 09:17:44 PM (7 years ago)
Author:
DrewAPicture
Message:

Inline documentation fixes related to the determine_current_user filter

See #26706, #27700.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/pluggable.php

    r27825 r28007  
    6767 *
    6868 * Will set the current user, if the current user is not set. The current user
    69  * will be set to the logged in person. If no user is logged in, then it will
     69 * will be set to the logged-in person. If no user is logged-in, then it will
    7070 * set the current user to 0, which is invalid and won't have any permissions.
    7171 *
    7272 * @since 0.71
     73 *
    7374 * @uses $current_user Checks if the current user is set
    7475 * @uses wp_validate_auth_cookie() Retrieves current logged in user.
    7576 *
    76  * @return bool|null False on XMLRPC Request and invalid auth cookie. Null when current user set
     77 * @return bool|null False on XML-RPC Request and invalid auth cookie. Null when current user set.
    7778 */
    7879function get_currentuserinfo() {
     
    103104
    104105    /**
    105      * Determine the current user based on request data.
     106     * Filter the current user.
    106107     *
    107108     * The default filters use this to determine the current user from the
    108109     * request's cookies, if available.
    109110     *
     111     * Returning a value of false will effectively short-circuit setting
     112     * the current user.
     113     *
    110114     * @since 3.9.0
    111115     *
    112      * @param int|bool $user_id User ID if determined, or false otherwise.
     116     * @param int|bool $user_id User ID if one has been determined, false otherwise.
    113117     */
    114118    $user_id = apply_filters( 'determine_current_user', false );
Note: See TracChangeset for help on using the changeset viewer.