is_protected_meta( string $meta_key, string|null $meta_type = null )

Determine whether a meta key is protected.


Description Description


Parameters Parameters

$meta_key

(string) (Required) Meta key

$meta_type

(string|null) (Optional) Type of object metadata is for (e.g., comment, post, term, or user).

Default value: null


Top ↑

Return Return

(bool) True if the key is protected, false otherwise.


Top ↑

Source Source

File: wp-includes/meta.php

function is_protected_meta( $meta_key, $meta_type = null ) {
	$protected = ( '_' == $meta_key[0] );

	/**
	 * Filters whether a meta key is protected.
	 *
	 * @since 3.2.0
	 *
	 * @param bool   $protected Whether the key is protected. Default false.
	 * @param string $meta_key  Meta key.
	 * @param string $meta_type Type of object metadata is for (e.g., comment, post, term, or user).
	 */
	return apply_filters( 'is_protected_meta', $protected, $meta_key, $meta_type );
}

Top ↑

Changelog Changelog

Changelog
Version Description
3.1.3 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.