sanitize_meta( string $meta_key, mixed $meta_value, string $object_type )

Sanitize meta value.


Description Description


Parameters Parameters

$meta_key

(string) (Required) Meta key.

$meta_value

(mixed) (Required) Meta value to sanitize.

$object_type

(string) (Required) Type of object the meta is registered to.


Top ↑

Return Return

(mixed) Sanitized $meta_value.


Top ↑

Source Source

File: wp-includes/meta.php

function sanitize_meta( $meta_key, $meta_value, $object_type ) {
	/**
	 * Filters the sanitization of a specific meta key of a specific meta type.
	 *
	 * The dynamic portions of the hook name, `$meta_type`, and `$meta_key`,
	 * refer to the metadata object type (comment, post, or user) and the meta
	 * key value, respectively.
	 *
	 * @since 3.3.0
	 *
	 * @param mixed  $meta_value      Meta value to sanitize.
	 * @param string $meta_key        Meta key.
	 * @param string $object_type     Object type.
	 */
	return apply_filters( "sanitize_{$object_type}_meta_{$meta_key}", $meta_value, $meta_key, $object_type );
}

Top ↑

Changelog Changelog

Changelog
Version Description
3.1.3 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note content
    Contributed by Codex

    Example

    $clean_value = sanitize_meta( 'birth-year', $user_input, 'user' );
    
    function wpdocs_sanitize_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 back and try again.', 'textdomain' ) );
    	}
    	return $year;
    }
    add_filter( 'sanitize_user_meta_birth-year', 'wpdocs_sanitize_birth_year_meta' );
    

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