A WordPress-centric search engine for devs and theme authors



is_protected_meta ›

Since3.1.3
Deprecatedn/a
› is_protected_meta ( $meta_key, $meta_type = '' )
Parameters: (2)
  • (string) $meta_key Metadata key.
    Required: Yes
  • (string) $meta_type Optional. Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', or any other object type with an associated meta table. Default empty.
    Required: No
    Default: (empty)
Returns:
  • (bool) Whether the meta key is considered protected.
Defined at:
Codex:

Determines whether a meta key is considered protected.



Related Functions: is_protected_endpoint, is_protected_ajax_action, _deprecated_argument, register_term_meta, populate_site_meta

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 );
}