Docs: Add a missing return notation and to the DocBlock for `WP_Session_Tokens::get_instance()`.

Also adds an inline reference to the `session_token_manager` hook in the description.

Props Shelob9 for the initial patch.
Fixes #40102.

Built from https://develop.svn.wordpress.org/trunk@40998


git-svn-id: http://core.svn.wordpress.org/trunk@40848 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2017-07-04 17:16:42 +00:00
parent c6ab84c4c4
commit 64cb817527
2 changed files with 5 additions and 4 deletions

View File

@ -35,16 +35,17 @@ abstract class WP_Session_Tokens {
} }
/** /**
* Get a session token manager instance for a user. * Retrieves a session token manager instance for a user.
* *
* This method contains a filter that allows a plugin to swap out * This method contains a {@see 'session_token_manager'} filter, allowing a plugin to swap out
* the session manager for a subclass of WP_Session_Tokens. * the session manager for a subclass of `WP_Session_Tokens`.
* *
* @since 4.0.0 * @since 4.0.0
* @access public * @access public
* @static * @static
* *
* @param int $user_id User whose session to manage. * @param int $user_id User whose session to manage.
* @return WP_User_Meta_Session_Tokens WP_User_Meta_Session_Tokens class instance by default.
*/ */
final public static function get_instance( $user_id ) { final public static function get_instance( $user_id ) {
/** /**

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.9-alpha-40997'; $wp_version = '4.9-alpha-40998';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.