Function __global->delete_session_by_member_id

Definitions

sources/users_active_actions.php

  • Delete a session by member ID.Caution: this does not log the member out of third-party providers.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$member_id MEMBER No No required parameter N/A N/A The member ID whose sessions should be deleted
$except_session ?ID_TEXT No No Null N/A N/A A session to not delete (null: no filter)

Preview

Code (PHP)

/**
 * Delete a session by member ID.Caution: this does not log the member out of third-party providers.
 *
 * @param  MEMBER $member_id The member ID whose sessions should be deleted
 * @param  ?ID_TEXT $except_session A session to not delete (null: no filter)
 */
function delete_session_by_member_id(int $member_id, ?string $except_session = null)