Changeset 40998

Timestamp:

07/04/2017 05:15:47 PM (7 years ago)

Author:

DrewAPicture

Message:

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.

File:

• trunk/src/wp-includes/class-wp-session-tokens.php (modified) (2 diffs)

trunk/src/wp-includes/class-wp-session-tokens.php

@@ -36 +36 @@
 
     /**
-     * Get 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.
+     * Retrieves a session token manager instance for a user.
+     *
+     * 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
@@ -46 +46 @@
      *
      * @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 ) {