attach_session_information

Filters the information attached to the newly created session.

Description

apply_filters( 'attach_session_information', (array) $array, (int) $this_user_id ); 

Could be used in the future to attach information such as IP address or user agent to a session.

Parameters (2)

0. $array (array) => array()
Array of extra data.
1. $this_user_id (int)
The this user id.

Usage

To run the hook, copy the example below.
  1. $array = apply_filters( 'attach_session_information', $array, $this_user_id ); 
  2.  
  3. if ( !empty( $array ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the attach_session_information callback 
  2. function filter_attach_session_information( $array, $this_user_id ) { 
  3. // make filter magic happen here... 
  4. return $array
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'attach_session_information', 'filter_attach_session_information', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'attach_session_information', 'filter_attach_session_information', 10, 2 ); 

Defined (1)

The filter is defined in the following location(s).

/wp-includes/session.php  
  1. $session = apply_filters( 'attach_session_information', array(), $this->user_id );