pre_user_id

Filters the comment author's user id before it is set.

Description

apply_filters( 'pre_user_id', (int) $commentdata_user_id ); 

The first time this filter is evaluated, user_ID is checked (for back-compat), followed by the standard user_id value.

Parameters (1)

0. $commentdata_user_id (int)
The comment author's user ID.

Usage

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

Defined (2)

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

/wp-includes/comment.php  
  1. $commentdata['user_id'] = apply_filters( 'pre_user_id', $commentdata['user_ID'] ); 
  1. $commentdata['user_id'] = apply_filters( 'pre_user_id', $commentdata['user_id'] );