WordPress.org
Get WordPress

Make WordPress Core


Ignore:
Timestamp:
09/14/2018 01:44:50 PM (7 years ago)
Author:
johnbillion
Message:

Docs: Correct and improve docblocks for user session management functionality.

See #42505

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-includes/class-wp-user-meta-session-tokens.php

    r42746 r43643  
    1616
    1717    /**
    18      * Get all sessions of a user.
     18     * Retrieves all sessions of the user.
    1919     *
    2020     * @since 4.0.0
    2121     *
    22      * @return array Sessions of a user.
     22     * @return array Sessions of the user.
    2323     */
    2424    protected function get_sessions() {
    … …  
    4848
    4949    /**
    50      * Retrieve a session by its verifier (token hash).
     50     * Retrieves a session based on its verifier (token hash).
    5151     *
    5252     * @since 4.0.0
    5353     *
    54      * @param string $verifier Verifier of the session to retrieve.
     54     * @param string $verifier Verifier for the session to retrieve.
    5555     * @return array|null The session, or null if it does not exist
    5656     */
    … …  
    6666
    6767    /**
    68      * Update a session by its verifier.
     68     * Updates a session based on its verifier (token hash).
    6969     *
    7070     * @since 4.0.0
    7171     *
    72      * @param string $verifier Verifier of the session to update.
     72     * @param string $verifier Verifier for the session to update.
    7373     * @param array  $session  Optional. Session. Omitting this argument destroys the session.
    7474     */
    … …  
    8686
    8787    /**
    88      * Update a user's sessions in the usermeta table.
     88     * Updates the user's sessions in the usermeta table.
    8989     *
    9090     * @since 4.0.0
    … …  
    101101
    102102    /**
    103      * Destroy all session tokens for a user, except a single session passed.
     103     * Destroys all sessions for this user, except the single session with the given verifier.
    104104     *
    105105     * @since 4.0.0
    … …  
    113113
    114114    /**
    115      * Destroy all session tokens for a user.
     115     * Destroys all session tokens for the user.
    116116     *
    117117     * @since 4.0.0
    … …  
    122122
    123123    /**
    124      * Destroy all session tokens for all users.
     124     * Destroys all sessions for all users.
    125125     *
    126126     * @since 4.0.0
Note: See TracChangeset for help on using the changeset viewer.