How to use insert_user_meta filter in WordPress

insert_user_meta filter

Does not include contact methods. These are added using wp_get_user_contact_methods( $user ).

To use insert_user_meta 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_insert_user_meta_defaults which takes 4 parameters and we registered using add_filter. The first parameter insert_user_meta is the name of the hook, The second parameter modify_insert_user_meta_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.

Sometime, you have to remove a registered hook so you can use remove_filter to remove insert_user_meta filter.

Example 1: Modifying Default User Meta

This example demonstrates how to modify the default meta values for a user when a new user is created.

    function weplugins_modify_insert_user_meta_defaults($meta, $user, $update, $userdata) {
        // Custom logic here.
        return $meta;
    }
    add_filter("insert_user_meta", "weplugins_modify_insert_user_meta_defaults", 10, 4);
    

Example 2: Adding Custom Meta Field

Here’s how you can add a custom meta field to the user’s metadata on creation.

    function weplugins_add_custom_meta($meta, $user, $update, $userdata) {
        $meta['custom_field'] = 'custom_value';
        return $meta;
    }
    add_filter("insert_user_meta", "weplugins_add_custom_meta", 10, 4);
    

Example 3: Conditional Meta Modification

This example shows how to conditionally modify user meta based on user role.

    function weplugins_conditional_meta_change($meta, $user, $update, $userdata) {
        if (in_array('administrator', $user->roles)) {
            $meta['show_admin_bar_front'] = 'false';
        }
        return $meta;
    }
    add_filter("insert_user_meta", "weplugins_conditional_meta_change", 10, 4);
    

If you’re having any trouble using this hook, please Contact Us for customization services.