How to use pre_user_first_name filter in WordPress

pre_user_first_name filter

Filters a user’s first name before the user is created or updated.

To use the pre_user_first_name 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_user_first_name_defaults which takes 1 parameter and we registered it using add_filter. The first parameter pre_user_first_name is the name of the hook, the second parameter modify_pre_user_first_name_defaults is the name of the function that 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 the pre_user_first_name filter.

Parameters

Below is the 1 parameter required to use this hook.

• $first_name: (string) The user’s first name.

Live Example

Adding the Filter

Below is an example of how you can use this hook.

function weplugins_modify_pre_user_first_name_defaults($first_name) { 

    // Update the $first_name variable according to your website requirements and return this variable. 
    // You can modify the $first_name variable conditionally too if you want.

    return $first_name; 
}
// add the filter
add_filter( "pre_user_first_name", "weplugins_modify_pre_user_first_name_defaults", 10, 1 );

Removing the Filter

To remove a hook callback, use the example below.

remove_filter( "pre_user_first_name", "weplugins_modify_pre_user_first_name_defaults", 10, 1 );

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

Example with Conditional Check

Below is an example of using the filter with a conditional check.

function weplugins_modify_pre_user_first_name_conditional($first_name) { 
    if ($first_name == 'Admin') {
        $first_name = 'Administrator';
    }
    return $first_name; 
}

add_filter( "pre_user_first_name", "weplugins_modify_pre_user_first_name_conditional", 10, 1 );

Contact Us

If you need any customization or are having trouble using this hook, please contact us and we’d be happy to assist you.