How to use pre_comment_user_ip filter in WordPress

pre_comment_user_ip Filter

Filters the comment author’s IP address before it is set.

To use pre_comment_user_ip filter, first you have to register it using add_filter. You can write this code into functions.php of your activated theme or in a custom WordPress Plugin.

We at WePlugins, always prefer to create a custom WordPress Plugin while using hooks so nothing breaks when you update your WordPress Theme in the future.

In the below live example, we have defined a function modify_pre_comment_user_ip_defaults which takes 1 parameter and we registered it using add_filter. The first parameter pre_comment_user_ip is the name of the hook, the second parameter modify_pre_comment_user_ip_defaults is the name of the function which needs to be called, the third parameter is the priority of calling the hook if the same hook is used multiple times, and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometimes, you have to remove a registered hook, so you can use remove_filter to remove pre_comment_user_ip filter.

Parameters

Below the 1 parameter is required to use this hook.

• $comment_author_ip: (string) The comment author’s IP address.

Live Example

Example 1: Basic Usage

This example shows how to modify the comment author’s IP address.

    add_filter( 'pre_comment_user_ip', 'weplugins_auto_reverse_proxy_pre_comment_user_ip');
    function weplugins_auto_reverse_proxy_pre_comment_user_ip() {    
        $REMOTE_ADDR = $_SERVER['REMOTE_ADDR'];
        if (!empty($_SERVER['X_FORWARDED_FOR'])) {
            $X_FORWARDED_FOR = explode(',', $_SERVER['X_FORWARDED_FOR']);
            if (!empty($X_FORWARDED_FOR)) {
                $REMOTE_ADDR = trim($X_FORWARDED_FOR[0]);
            }
        }
        return $REMOTE_ADDR;
    }
    

Example 2: Custom Modification

Below is an example of how you can use this hook to modify the IP address conditionally.

    function weplugins_modify_pre_comment_user_ip_defaults($comment_author_ip) {
        // Update the $comment_author_ip variable according to your website requirements and return this variable.
        // You can modify the $comment_author_ip variable conditionally too if you want.
        return $comment_author_ip;
    }
    // Add the filter
    add_filter( "pre_comment_user_ip", "weplugins_modify_pre_comment_user_ip_defaults", 10, 1 );
    

Example 3: Removing the Hook

To remove a hook callback, use the example below.

    remove_filter( "pre_comment_user_ip", "weplugins_modify_pre_comment_user_ip_defaults", 10, 1 );
    

Please make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.

If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.