pre_comment_user_ip

Filters the comment author's IP before it is set.

Description

apply_filters( 'pre_comment_user_ip', (string) $commentdata_comment_author_ip ); 

Parameters (1)

0. $commentdata_comment_author_ip (string)
The commentdata comment author ip.

Usage

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

Defined (1)

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

/wp-includes/comment.php  
  1. $commentdata['comment_author_IP'] = apply_filters( 'pre_comment_user_ip', $commentdata['comment_author_IP'] );