WP_Session_Tokens

15#[AllowDynamicProperties]16abstract class WP_Session_Tokens {17 18	/**19	 * User ID.20	 *21	 * @since 4.0.022	 * @var int User ID.23	 */24	protected $user_id;25 26	/**27	 * Protected constructor. Use the `get_instance()` method to get the instance.28	 *29	 * @since 4.0.030	 *31	 * @param int $user_id User whose session to manage.32	 */33	protected function __construct( $user_id ) {34		$this->user_id = $user_id;35	}36 37	/**38	 * Retrieves a session manager instance for a user.39	 *40	 * This method contains a {@see 'session_token_manager'} filter, allowing a plugin to swap out41	 * the session manager for a subclass of `WP_Session_Tokens`.42	 *43	 * @since 4.0.044	 *45	 * @param int $user_id User whose session to manage.46	 * @return WP_Session_Tokens The session object, which is by default an instance of47	 *                           the `WP_User_Meta_Session_Tokens` class.48	 */49	final public static function get_instance( $user_id ) {50		/**51		 * Filters the class name for the session token manager.52		 *53		 * @since 4.0.054		 *55		 * @param string $session Name of class to use as the manager.56		 *                        Default 'WP_User_Meta_Session_Tokens'.57		 */58		$manager = apply_filters( 'session_token_manager', 'WP_User_Meta_Session_Tokens' );59		return new $manager( $user_id );60	}61 62	/**63	 * Hashes the given session token for storage.64	 *65	 * @since 4.0.066	 *67	 * @param string $token Session token to hash.68	 * @return string A hash of the session token (a verifier).69	 */70	private function hash_token( $token ) {71		return hash( 'sha256', $token );72	}73 74	/**75	 * Retrieves a user's session for the given token.76	 *77	 * @since 4.0.078	 *79	 * @param string $token Session token.80	 * @return array|null The session, or null if it does not exist.81	 */82	final public function get( $token ) {83		$verifier = $this->hash_token( $token );84		return $this->get_session( $verifier );85	}86 87	/**88	 * Validates the given session token for authenticity and validity.89	 *90	 * Checks that the given token is present and hasn't expired.91	 *92	 * @since 4.0.093	 *94	 * @param string $token Token to verify.