How to use map_meta_cap filter in WordPress

map_meta_cap filter

Filters the primitive capabilities required of the given user to satisfy the capability being checked.

To use the map_meta_cap 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.

At WePlugins, we 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_map_meta_cap_defaults which takes 4 parameters and we registered it using add_filter. The first parameter map_meta_cap is the name of the hook, the second parameter weplugins_modify_map_meta_cap_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 the map_meta_cap filter.

Parameters

Below are the 4 parameters required to use this hook.

• $caps: (string[]) Primitive capabilities required of the user.
• $cap: (string) Capability being checked.
• $user_id: (int) The user ID.
• $args: (array) Adds context to the capability check, typically starting with an object ID.

Live Examples

Example 1: Basic Usage

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

	function weplugins_modify_map_meta_cap_defaults($caps, $cap, $user_id, $args) { 
		// Update the $caps variable according to your website requirements and return this variable. You can modify the $caps variable conditionally too if you want.
		return $caps; 
	}
	// add the filter
	add_filter("map_meta_cap", "weplugins_modify_map_meta_cap_defaults", 10, 4);
	

Example 2: Remove Hook Callback

To remove a hook callback, use the example below.

	remove_filter("map_meta_cap", "weplugins_modify_map_meta_cap_defaults", 10, 4);
	

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

Example 3: Conditional Capability Check

Here’s an example where the $caps variable is modified conditionally.

	function weplugins_modify_map_meta_cap_defaults($caps, $cap, $user_id, $args) {
		if ($cap == 'edit_post' && $user_id == 1) {
			$caps[] = 'manage_options';
		}
		return $caps;
	}
	// add the filter
	add_filter("map_meta_cap", "weplugins_modify_map_meta_cap_defaults", 10, 4);
	

Contact Us

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