W3cubDocs

/WordPress

WP_Session_Tokens::create( int $expiration )

Generates a session token and attaches session information to it.

Description

A session token is a long, random string. It is used in a cookie to link that cookie to an expiration time and to ensure the cookie becomes invalidated when the user logs out.

This function generates a token and stores it with the associated expiration time (and potentially other session information via the ‘attach_session_information’ filter).

Parameters

$expiration

(int) (Required) Session expiration timestamp.

Return

(string) Session token.

Source

File: wp-includes/class-wp-session-tokens.php 

final public function create( $expiration ) {
		/**
		 * Filters the information attached to the newly created session.
		 *
		 * Can be used to attach further information to a session.
		 *
		 * @since 4.0.0
		 *
		 * @param array $session Array of extra data.
		 * @param int   $user_id User ID.
		 */
		$session               = apply_filters( 'attach_session_information', array(), $this->user_id );
		$session['expiration'] = $expiration;

		// IP address.
		if ( ! empty( $_SERVER['REMOTE_ADDR'] ) ) {
			$session['ip'] = $_SERVER['REMOTE_ADDR'];
		}

		// User-agent.
		if ( ! empty( $_SERVER['HTTP_USER_AGENT'] ) ) {
			$session['ua'] = wp_unslash( $_SERVER['HTTP_USER_AGENT'] );
		}

		// Timestamp.
		$session['login'] = time();

		$token = wp_generate_password( 43, false, false );

		$this->update( $token, $session );

		return $token;
	}

Uses

Uses Description
wp-includes/class-wp-session-tokens.php: WP_Session_Tokens::update()

Updates the data for the session with the given token.
wp-includes/class-wp-session-tokens.php: attach_session_information

Filters the information attached to the newly created session.
wp-includes/formatting.php: wp_unslash()

Remove slashes from a string or array of strings.
wp-includes/pluggable.php: wp_generate_password()

Generates a random password drawn from the defined set of characters.
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.

Changelog

Version Description
4.0.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_session_tokens/create