Determines whether a meta key is considered protected.
Parameters
$meta_keystringrequired- Metadata key.
$meta_typestringoptional- Type of object metadata is for. Accepts
'post','comment','term','user', or any other object type with an associated meta table.Default:
''
Source
function is_protected_meta( $meta_key, $meta_type = '' ) {
$sanitized_key = preg_replace( "/[^\x20-\x7E\p{L}]/", '', $meta_key );
$protected = strlen( $sanitized_key ) > 0 && ( '_' === $sanitized_key[0] );
/**
* Filters whether a meta key is considered protected.
*
* @since 3.2.0
*
* @param bool $protected Whether the key is considered protected.
* @param string $meta_key Metadata key.
* @param string $meta_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user',
* or any other object type with an associated meta table.
*/
return apply_filters( 'is_protected_meta', $protected, $meta_key, $meta_type );
}
Hooks
- apply_filters( ‘is_protected_meta’,
bool $protected ,string $meta_key ,string $meta_type ) Filters whether a meta key is considered protected.
Changelog
| Version | Description |
|---|---|
| 3.1.3 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.