auth_{$object_type}_{$sub_type}_meta_{$meta_key} WordPress Filter Hook

The auth_{$object_type}_{$sub_type}_meta_{$meta_key} hook is used to filter the value of a user or term meta field. This hook is called when the value of a user or term meta field is being retrieved. The hook is called once for each user or term meta field. The $object_type parameter can be either 'user' or 'term'. The $sub_type parameter is the user or term meta field key. The $meta_key parameter is the meta key of the user or term meta field. This hook can be used to filter the value of a user or term meta field.

apply_filters( "auth_{$object_type}_{$sub_type}_meta_{$meta_key}", bool $allowed, string $meta_key, int $post_id, int $user_id, string $cap, array $caps ) #

Filters whether the user is allowed to add post meta to a post of a given type.


Description

Use the auth_$object_type_$sub_type_meta_$meta_key filter to modify capabilities for specific object types/subtypes. Return true to have the mapped meta caps from edit_{$object_type} apply.

The dynamic portion of the hook name, $object_type refers to the object type being filtered. The dynamic portion of the hook name, $sub_type refers to the object subtype being filtered. The dynamic portion of the hook name, $meta_key, refers to the meta key passed to map_meta_cap().


Top ↑

Parameters

$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.


Top ↑

Source

File: wp-includes/capabilities.php

View on Trac


Top ↑

Changelog

Changelog
VersionDescription
4.7.0
4.6.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.