auth_<object_type>_meta_<meta_key>
This filter is documented in wp-includes/meta.php.
Description
Parameters (6)
- 0. $false (bool) =>
false
- The false.
- 1. $meta_key (unknown)
- The meta key.
- 2. $object_id (unknown)
- The object id.
- 3. $user_id (unknown)
- The user id.
- 4. $cap (unknown)
- The cap.
- 5. $caps (unknown)
- The caps.
Usage
- To run the hook, copy the example below.
- $false = apply_filters( 'auth_{$object_type}_meta_{$meta_key}', $false, $meta_key, $object_id, $user_id, $cap, $caps );
- if ( !empty( $false ) ) {
- // everything has led up to this point...
- }
- The following example is for adding a hook callback.
- // define the auth_<object_type>_meta_<meta_key> callback
- function filter_auth_object_type_meta_meta_key( $false, $meta_key, $object_id, $user_id, $cap, $caps ) {
- // make filter magic happen here...
- return $false;
- };
- // add the filter
- add_filter( "auth_{$object_type}_meta_{$meta_key}", 'filter_auth_object_type_meta_meta_key', 10, 6 );
- To remove a hook callback, use the example below.
- // remove the filter
- remove_filter( "auth_{$object_type}_meta_{$meta_key}", 'filter_auth_object_type_meta_meta_key', 10, 6 );
Defined (1)
The filter is defined in the following location(s).
- /wp-includes/capabilities.php
- $allowed = apply_filters( "auth_{$object_type}_meta_{$meta_key}", false, $meta_key, $object_id, $user_id, $cap, $caps );