How to use auth_object_type_object_subtype_meta_meta_key filter in WordPress

auth_object_type_object_subtype_meta_meta_key filter

Return true to have the mapped meta caps from edit_{$object_type} apply.

To use auth_object_type_object_subtype_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_object_type_object_subtype_meta_meta_key_defaults which takes 6 parameters and we registered using add_filter. The first parameter auth_object_type_object_subtype_meta_meta_key is the name of the hook, the second parameter modify_auth_object_type_object_subtype_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_object_type_object_subtype_meta_meta_key filter.

Parameters

Below are the 6 parameters required to use this hook.

• $allowed : (bool) Whether the user can add the object meta. Default false.
• $meta_key : (string) The meta key.
• $object_id : (int) Object ID.
• $user_id : (int) User ID.
• $cap : (string) Capability name.
• $caps : (string[]) Array of the user’s capabilities.

Live Examples

Example 1: Basic Usage

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

    function weplugins_modify_auth_object_type_object_subtype_meta_meta_key_defaults($allowed, $meta_key, $object_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_object_type_object_subtype_meta_meta_key", "weplugins_modify_auth_object_type_object_subtype_meta_meta_key_defaults", 10, 6 );
    

Example 2: Removing a Hook

To remove a hook callback, use the example below.

    remove_filter( "auth_object_type_object_subtype_meta_meta_key", "weplugins_modify_auth_object_type_object_subtype_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 3: Conditional Check

Here’s an example where the $allowed variable is modified based on a condition.

    function weplugins_modify_auth_object_type_object_subtype_meta_meta_key_defaults($allowed, $meta_key, $object_id, $user_id, $cap, $caps) { 
        if ($meta_key == 'custom_meta_key') {
            $allowed = true; 
        }
        return $allowed; 
    }
    // add the filter
    add_filter( "auth_object_type_object_subtype_meta_meta_key", "weplugins_modify_auth_object_type_object_subtype_meta_meta_key_defaults", 10, 6 );
    

Contact Us

If you need any customization or have any trouble using this hook, please Contact Us.