bp_member_switching_get_auth_cookie()

Gets the value of the auth cookie containing the list of originating users.

Description

Return

(string[]) Array of originating user authentication cookie values. Empty array if there are none.

Source

File: bp-members/bp-members-functions.php

function bp_member_switching_get_auth_cookie() {
	if ( BP_Core_Members_Switching::secure_auth_cookie() ) {
		$auth_cookie_name = BP_MEMBER_SWITCHING_SECURE_COOKIE;
	} else {
		$auth_cookie_name = BP_MEMBER_SWITCHING_COOKIE;
	}

	if ( isset( $_COOKIE[ $auth_cookie_name ] ) && is_string( $_COOKIE[ $auth_cookie_name ] ) ) {
		$cookie = json_decode( wp_unslash( $_COOKIE[ $auth_cookie_name ] ) ); // WPCS: sanitization ok
	}
	if ( ! isset( $cookie ) || ! is_array( $cookie ) ) {
		$cookie = array();
	}

	return $cookie;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyBoss 1.0.0	Introduced.

Uses

Uses
Uses	Description
bp-members/classes/class-bp-core-members-switching.php: BP_Core_Members_Switching::secure_auth_cookie()	Returns whether or not Member Switching’s equivalent of the ‘auth’ cookie should be secure.

Used By
Used By	Description
bp-members/bp-members-functions.php: bp_member_switching_set_olduser_cookie()	Sets authorization cookies containing the originating user information.
bp-members/bp-members-functions.php: bp_member_switching_clear_olduser_cookie()	Clears the cookies containing the originating user, or pops the latest item off the end if there’s more than one.
bp-members/bp-members-functions.php: bp_member_switch_to()	Switches the current logged in user to the specified user.
bp-members/classes/class-bp-core-members-switching.php: BP_Core_Members_Switching::authenticate_old_user()	Authenticates an old user by verifying the latest entry in the auth cookie.

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.

Contents