How to use auth_post_meta_meta_key filter in WordPress

auth_post_meta_meta_key filter

The dynamic portion of the hook name, $meta_key, refers to the meta key passed to map_meta_cap().

To use auth_post_meta_meta_key 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_auth_post_meta_meta_key_defaults which takes 6 parameters and we registered using add_filter. The first parameter auth_post_meta_meta_key is the name of the hook, the second parameter modify_auth_post_meta_meta_key_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 auth_post_meta_meta_key filter.

Parameters

Below are the 6 parameters required to use this hook.

• $allowed : (bool) Whether the user can add the post meta. Default false.
• $meta_key : (string) The meta key.
• $post_id : (int) Post ID.
• $user_id : (int) User ID.
• $cap : (string) Capability name.
• $caps : (array) User capabilities.

Live Example

apply_filters( "auth_post_meta_{$meta_key}", bool $allowed, string $meta_key, int $post_id, int $user_id, string $cap, array $caps )

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

    function weplugins_modify_auth_post_meta_meta_key_defaults($allowed, $meta_key, $post_id, $user_id, $cap, $caps) { 
        // Update the $allowed variable according to your website requirements and return this variable. You can modify the $allowed variable conditionally too if you want.
        return $allowed; 
    }
    // add the filter
    add_filter( "auth_post_meta_meta_key", "weplugins_modify_auth_post_meta_meta_key_defaults", 10, 6 );
    

To remove a hook callback, use the example below.

    remove_filter( "auth_post_meta_meta_key", "weplugins_modify_auth_post_meta_meta_key_defaults", 10, 6 );
    

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

Example 1: Custom Meta Key Permission

Adds custom permission for a specific meta key.

    function weplugins_custom_meta_key_permission($allowed, $meta_key, $post_id, $user_id, $cap, $caps) { 
        if ($meta_key == 'custom_meta_key') {
            $allowed = true; 
        }
        return $allowed; 
    }
    add_filter( "auth_post_meta_meta_key", "weplugins_custom_meta_key_permission", 10, 6 );
    

Example 2: Restrict Meta Key for Specific User

Restricts a meta key for a specific user ID.

    function weplugins_restrict_meta_key_for_user($allowed, $meta_key, $post_id, $user_id, $cap, $caps) { 
        if ($user_id == 123 && $meta_key == 'restricted_meta_key') {
            $allowed = false; 
        }
        return $allowed; 
    }
    add_filter( "auth_post_meta_meta_key", "weplugins_restrict_meta_key_for_user", 10, 6 );
    

Example 3: Conditional Meta Key Permission

Allows or disallows meta key based on post type.

    function weplugins_conditional_meta_key_permission($allowed, $meta_key, $post_id, $user_id, $cap, $caps) { 
        $post_type = get_post_type($post_id);
        if ($post_type == 'custom_post_type' && $meta_key == 'conditional_meta_key') {
            $allowed = true; 
        }
        return $allowed; 
    }
    add_filter( "auth_post_meta_meta_key", "weplugins_conditional_meta_key_permission", 10, 6 );
    

Contact Us

If you need any customization or have trouble using this hook, feel free to Contact Us.