How to use pre_user_last_name filter in WordPress

pre_user_last_name filter

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

To use pre_user_last_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 weplugins_modify_pre_user_last_name_defaults which takes 1 parameter and we registered using add_filter. The first parameter pre_user_last_name is the name of the hook, the second parameter weplugins_modify_pre_user_last_name_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_user_last_name filter.

Parameters

Below the 1 parameter is required to use this hook.

• $last_name : (string) The user’s last name.

Live Example

apply_filters( 'pre_user_last_name', string $last_name )

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

Example 1: Modify Last Name

This example demonstrates how to modify the user’s last name before it is saved.

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

Example 2: Remove Hook Callback

To remove a hook callback, use the example below.

    remove_filter( "pre_user_last_name", "weplugins_modify_pre_user_last_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 3: Conditional Last Name Change

This example shows how to conditionally change the last name based on specific requirements.

    function weplugins_modify_pre_user_last_name_conditionally($last_name) { 
        if ($last_name == 'Doe') {
            $last_name = 'Smith';
        }
        return $last_name; 
    }
    // add the filter
    add_filter( "pre_user_last_name", "weplugins_modify_pre_user_last_name_conditionally", 10, 1 );
    

Contact Us

If you need any customization or have trouble using this hook, please contact us.