From 7bc5812ab33ef7da7afe46062c90c50dc839f90e Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Tue, 4 Jul 2017 17:15:47 +0000 Subject: [PATCH] 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. git-svn-id: https://develop.svn.wordpress.org/trunk@40998 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/class-wp-session-tokens.php | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/wp-includes/class-wp-session-tokens.php b/src/wp-includes/class-wp-session-tokens.php index 1e381addf8..b1f90bfd5c 100644 --- a/src/wp-includes/class-wp-session-tokens.php +++ b/src/wp-includes/class-wp-session-tokens.php @@ -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 - * the session manager for a subclass of WP_Session_Tokens. + * 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`. * * @since 4.0.0 * @access public * @static * * @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 ) { /**