is_protected_meta( string $meta_key, string $meta_type = '' )

Determines whether a meta key is considered protected.


Parameters Parameters

$meta_key

(string) (Required) Metadata key.

$meta_type

(string) (Optional) Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', or any other object type with an associated meta table.

Default value: ''


Top ↑

Return Return

(bool) Whether the meta key is considered protected.


Top ↑

Source Source

File: wp-includes/meta.php

function is_protected_meta( $meta_key, $meta_type = '' ) {
	$protected = ( '_' === $meta_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 );
}


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.