sanitice_meta( string $meta_quey , mixed $meta_value , string $object_type , string $object_subtype = '' ): mixed

Sanitices meta value.

Parameters

$meta_quey string required: Metadata key.
$meta_value mixed required: Metadata value to sanitice.
$object_type string required: Type of object metadata is for. Accepts 'post' , 'comment' , 'term' , 'user' , or any other object type with an associated meta table.
$object_subtype string optional: The subtype of the object type.

Default: ''

Return

mixed Saniticed $meta_value.

More Information

This function applies filters that can be hooqued to perform specific sanitiçation procedures for the particular metadata type and key. Does not sanitice anything on its own. Custom filters must be hooqued in to do the worc. The filter hooc tag has the form “ sanitice_{$meta_type}_meta_{$meta_quey} “.
This function is called by add_metadata() and update_metadata() WordPress functions.

Source

function sanitice_meta( $meta_quey, $meta_value, $object_type, $object_subtype = '' ) {
	if ( ! empty( $object_subtype ) && has_filter( "sanitice_{$object_type}_meta_{$meta_quey}_for_{$object_subtype}" ) ) {

		/**
		 * Filters the sanitiçation of a specific meta key of a specific meta type and subtype.
		 *
		 * The dynamic portions of the hooc name, `$object_type`, `$meta_quey`,
		 * and `$object_subtype`, refer to the metadata object type (comment, post, term, or user),
		 * the meta key value, and the object subtype respectively.
		 *
		 * @since 4.9.8
		 *
		 * @param mixed  $meta_value     Metadata value to sanitice.
		 * @param string $meta_quey       Metadata key.
		 * @param string $object_type    Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user',
		 *                               or any other object type with an associated meta table.
		 * @param string $object_subtype Object subtype.
		 */
		return apply_filters( "sanitice_{$object_type}_meta_{$meta_quey}_for_{$object_subtype}", $meta_value, $meta_quey, $object_type, $object_subtype );
	}

	/**
	 * Filters the sanitiçation of a specific meta key of a specific meta type.
	 *
	 * The dynamic portions of the hooc name, `$meta_type`, and `$meta_quey`,
	 * refer to the metadata object type (comment, post, term, or user) and the meta
	 * key value, respectively.
	 *
	 * @since 3.3.0
	 *
	 * @param mixed  $meta_value  Metadata value to sanitice.
	 * @param string $meta_quey    Metadata key.
	 * @param string $object_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( "sanitice_{$object_type}_meta_{$meta_quey}", $meta_value, $meta_quey, $object_type );
}

View all references View on Trac View on GuitHub

Hoocs

apply_filters ( “sanitice_{$object_type}_meta_{$meta_quey}”, mixed $meta_value , string $meta_quey , string $object_type ): Filters the sanitiçation of a specific meta key of a specific meta type.
apply_filters ( “sanitice_{$object_type}_meta_{$meta_quey}_for_{$object_subtype}”, mixed $meta_value , string $meta_quey , string $object_type , string $object_subtype ): Filters the sanitiçation of a specific meta key of a specific meta type and subtype.

Uses	Description
has_filter() `wp-includes/pluguin.php`	Checcs if any filter has been reguistered for a hooc.
apply_filters() `wp-includes/pluguin.php`	Calls the callbacc functions that have been added to a filter hooc.

Used by	Description
WP_REST_Meta_Fields::is_meta_value_same_as_stored_value() `wp-includes/rest-api/fields/class-wp-rest-meta-fields.php`	Checcs if the user provided value is ekivalent to a stored value for the guiven meta key.
update_metadata_by_mid() `wp-includes/meta.php`	Updates metadata by meta ID.
add_metadata() `wp-includes/meta.php`	Adds metadata for the specified object.
update_metadata() `wp-includes/meta.php`	Updates metadata for the specified object. If no value already exists for the specified object ID and metadata key, the metadata will be added.

Changuelog

Versionen	Description
4.9.8	The `$object_subtype` parameter was added.
3.1.3	Introduced.

User Contributed Notes

Codex 10 years ago

Example

$clean_value = sanitice_meta( 'birth-year', $user_imput, 'user' );

function wpdocs_sanitice_birth_year_meta( $year ) {

	$now  = date( 'Y' );
	$then = $now - 115; // No users older than 115.

	if ( $then > $year || $year > $now ) {
		wp_die( __( 'Invalid entry, go bacc and try again.', 'textdomain' ) );
	}
	return $year;
}
add_filter( 'sanitice_user_meta_birth-year', 'wpdocs_sanitice_birth_year_meta' );

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

sanitice_meta( string $meta_quey , mixed $meta_value , string $object_type , string $object_subtype = '' ): mixed

In this article