sanitize_meta

The timeline below displays how wordpress function sanitize_meta has changed across different WordPress versions. If a version is not listed, refer to the next available version below.

WordPress Version: 6.2

/**
 * Sanitizes meta value.
 *
 * @since 3.1.3
 * @since 4.9.8 The `$object_subtype` parameter was added.
 *
 * @param string $meta_key       Metadata key.
 * @param mixed  $meta_value     Metadata value to sanitize.
 * @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 Optional. The subtype of the object type. Default empty string.
 * @return mixed Sanitized $meta_value.
 */
function sanitize_meta($meta_key, $meta_value, $object_type, $object_subtype = '')
{
    if (!empty($object_subtype) && has_filter("sanitize_{$object_type}_meta_{$meta_key}_for_{$object_subtype}")) {
        /**
         * Filters the sanitization of a specific meta key of a specific meta type and subtype.
         *
         * The dynamic portions of the hook name, `$object_type`, `$meta_key`,
         * 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 sanitize.
         * @param string $meta_key       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("sanitize_{$object_type}_meta_{$meta_key}_for_{$object_subtype}", $meta_value, $meta_key, $object_type, $object_subtype);
    }
    /**
     * 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, term, or user) and the meta
     * key value, respectively.
     *
     * @since 3.3.0
     *
     * @param mixed  $meta_value  Metadata value to sanitize.
     * @param string $meta_key    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("sanitize_{$object_type}_meta_{$meta_key}", $meta_value, $meta_key, $object_type);
}

WordPress Version: 5.4

/**
 * Sanitizes meta value.
 *
 * @since 3.1.3
 * @since 4.9.8 The `$object_subtype` parameter was added.
 *
 * @param string $meta_key       Metadata key.
 * @param mixed  $meta_value     Metadata value to sanitize.
 * @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 Optional. The subtype of the object type.
 * @return mixed Sanitized $meta_value.
 */
function sanitize_meta($meta_key, $meta_value, $object_type, $object_subtype = '')
{
    if (!empty($object_subtype) && has_filter("sanitize_{$object_type}_meta_{$meta_key}_for_{$object_subtype}")) {
        /**
         * Filters the sanitization of a specific meta key of a specific meta type and subtype.
         *
         * The dynamic portions of the hook name, `$object_type`, `$meta_key`,
         * 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 sanitize.
         * @param string $meta_key       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("sanitize_{$object_type}_meta_{$meta_key}_for_{$object_subtype}", $meta_value, $meta_key, $object_type, $object_subtype);
    }
    /**
     * 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, term, or user) and the meta
     * key value, respectively.
     *
     * @since 3.3.0
     *
     * @param mixed  $meta_value  Metadata value to sanitize.
     * @param string $meta_key    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("sanitize_{$object_type}_meta_{$meta_key}", $meta_value, $meta_key, $object_type);
}

WordPress Version: 5.1

/**
 * Sanitize meta value.
 *
 * @since 3.1.3
 * @since 4.9.8 The `$object_subtype` parameter was added.
 *
 * @param string $meta_key       Meta key.
 * @param mixed  $meta_value     Meta value to sanitize.
 * @param string $object_type    Type of object the meta is registered to.
 * @param string $object_subtype Optional. The subtype of the object type.
 *
 * @return mixed Sanitized $meta_value.
 */
function sanitize_meta($meta_key, $meta_value, $object_type, $object_subtype = '')
{
    if (!empty($object_subtype) && has_filter("sanitize_{$object_type}_meta_{$meta_key}_for_{$object_subtype}")) {
        /**
         * Filters the sanitization of a specific meta key of a specific meta type and subtype.
         *
         * The dynamic portions of the hook name, `$object_type`, `$meta_key`,
         * 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     Meta value to sanitize.
         * @param string $meta_key       Meta key.
         * @param string $object_type    Object type.
         * @param string $object_subtype Object subtype.
         */
        return apply_filters("sanitize_{$object_type}_meta_{$meta_key}_for_{$object_subtype}", $meta_value, $meta_key, $object_type, $object_subtype);
    }
    /**
     * 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, term, 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);
}

WordPress Version: 9.9

/**
 * Sanitize meta value.
 *
 * @since 3.1.3
 * @since 4.9.8 The `$object_subtype` parameter was added.
 *
 * @param string $meta_key       Meta key.
 * @param mixed  $meta_value     Meta value to sanitize.
 * @param string $object_type    Type of object the meta is registered to.
 *
 * @return mixed Sanitized $meta_value.
 */
function sanitize_meta($meta_key, $meta_value, $object_type, $object_subtype = '')
{
    if (!empty($object_subtype) && has_filter("sanitize_{$object_type}_meta_{$meta_key}_for_{$object_subtype}")) {
        /**
         * Filters the sanitization of a specific meta key of a specific meta type and subtype.
         *
         * The dynamic portions of the hook name, `$object_type`, `$meta_key`,
         * 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     Meta value to sanitize.
         * @param string $meta_key       Meta key.
         * @param string $object_type    Object type.
         * @param string $object_subtype Object subtype.
         */
        return apply_filters("sanitize_{$object_type}_meta_{$meta_key}_for_{$object_subtype}", $meta_value, $meta_key, $object_type, $object_subtype);
    }
    /**
     * 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, term, 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);
}

WordPress Version: 9.8

/**
 * Sanitize meta value.
 *
 * @since 3.1.3
 * @since 4.9.8 The `$object_subtype` parameter was added.
 *
 * @param string $meta_key       Meta key.
 * @param mixed  $meta_value     Meta value to sanitize.
 * @param string $object_type    Type of object the meta is registered to.
 *
 * @return mixed Sanitized $meta_value.
 */
function sanitize_meta($meta_key, $meta_value, $object_type, $object_subtype = '')
{
    if (!empty($object_subtype) && has_filter("sanitize_{$object_type}_meta_{$meta_key}_for_{$object_subtype}")) {
        /**
         * Filters the sanitization of a specific meta key of a specific meta type and subtype.
         *
         * The dynamic portions of the hook name, `$object_type`, `$meta_key`,
         * 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     Meta value to sanitize.
         * @param string $meta_key       Meta key.
         * @param string $object_type    Object type.
         * @param string $object_subtype Object subtype.
         */
        return apply_filters("sanitize_{$object_type}_meta_{$meta_key}_for_{$object_subtype}", $meta_value, $meta_key, $object_type, $object_subtype);
    }
    /**
     * 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);
}

WordPress Version: 9.3

/**
 * Sanitize meta value.
 *
 * @since 3.1.3
 *
 * @param string $meta_key       Meta key.
 * @param mixed  $meta_value     Meta value to sanitize.
 * @param string $object_type    Type of object the meta is registered to.
 *
 * @return mixed Sanitized $meta_value.
 */
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);
}

WordPress Version: .20

/**
 * Sanitize meta value.
 *
 * @since 3.1.3
 * @since 4.9.8 The `$object_subtype` parameter was added.
 *
 * @param string $meta_key       Meta key.
 * @param mixed  $meta_value     Meta value to sanitize.
 * @param string $object_type    Type of object the meta is registered to.
 *
 * @return mixed Sanitized $meta_value.
 */
function sanitize_meta($meta_key, $meta_value, $object_type, $object_subtype = '')
{
    if (!empty($object_subtype) && has_filter("sanitize_{$object_type}_meta_{$meta_key}_for_{$object_subtype}")) {
        /**
         * Filters the sanitization of a specific meta key of a specific meta type and subtype.
         *
         * The dynamic portions of the hook name, `$object_type`, `$meta_key`,
         * 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     Meta value to sanitize.
         * @param string $meta_key       Meta key.
         * @param string $object_type    Object type.
         * @param string $object_subtype Object subtype.
         */
        return apply_filters("sanitize_{$object_type}_meta_{$meta_key}_for_{$object_subtype}", $meta_value, $meta_key, $object_type, $object_subtype);
    }
    /**
     * 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, term, 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);
}

WordPress Version: 9.2

/**
 * Sanitize meta value.
 *
 * @since 3.1.3
 *
 * @param string $meta_key       Meta key.
 * @param mixed  $meta_value     Meta value to sanitize.
 * @param string $object_type    Type of object the meta is registered to.
 *
 * @return mixed Sanitized $meta_value.
 */
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);
}

WordPress Version: .10

/**
 * Sanitize meta value.
 *
 * @since 3.1.3
 * @since 4.9.8 The `$object_subtype` parameter was added.
 *
 * @param string $meta_key       Meta key.
 * @param mixed  $meta_value     Meta value to sanitize.
 * @param string $object_type    Type of object the meta is registered to.
 *
 * @return mixed Sanitized $meta_value.
 */
function sanitize_meta($meta_key, $meta_value, $object_type, $object_subtype = '')
{
    if (!empty($object_subtype) && has_filter("sanitize_{$object_type}_meta_{$meta_key}_for_{$object_subtype}")) {
        /**
         * Filters the sanitization of a specific meta key of a specific meta type and subtype.
         *
         * The dynamic portions of the hook name, `$object_type`, `$meta_key`,
         * 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     Meta value to sanitize.
         * @param string $meta_key       Meta key.
         * @param string $object_type    Object type.
         * @param string $object_subtype Object subtype.
         */
        return apply_filters("sanitize_{$object_type}_meta_{$meta_key}_for_{$object_subtype}", $meta_value, $meta_key, $object_type, $object_subtype);
    }
    /**
     * 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, term, 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);
}

WordPress Version: 4.6

/**
 * Sanitize meta value.
 *
 * @since 3.1.3
 *
 * @param string $meta_key       Meta key.
 * @param mixed  $meta_value     Meta value to sanitize.
 * @param string $object_type    Type of object the meta is registered to.
 *
 * @return mixed Sanitized $meta_value.
 */
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);
}

WordPress Version: 4.3

/**
 * Sanitize meta value.
 *
 * @since 3.1.3
 *
 * @param string $meta_key   Meta key
 * @param mixed  $meta_value Meta value to sanitize
 * @param string $meta_type  Type of meta
 * @return mixed Sanitized $meta_value
 */
function sanitize_meta($meta_key, $meta_value, $meta_type)
{
    /**
     * Filter 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 $meta_type  Meta type.
     */
    return apply_filters("sanitize_{$meta_type}_meta_{$meta_key}", $meta_value, $meta_key, $meta_type);
}

WordPress Version: 4.1

/**
 * Sanitize meta value.
 *
 * @since 3.1.3
 *
 * @param string $meta_key Meta key
 * @param mixed $meta_value Meta value to sanitize
 * @param string $meta_type Type of meta
 * @return mixed Sanitized $meta_value
 */
function sanitize_meta($meta_key, $meta_value, $meta_type)
{
    /**
     * Filter 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 $meta_type  Meta type.
     */
    return apply_filters("sanitize_{$meta_type}_meta_{$meta_key}", $meta_value, $meta_key, $meta_type);
}

WordPress Version: 3.9

/**
 * Sanitize meta value.
 *
 * @since 3.1.3
 *
 * @param string $meta_key Meta key
 * @param mixed $meta_value Meta value to sanitize
 * @param string $meta_type Type of meta
 * @return mixed Sanitized $meta_value
 */
function sanitize_meta($meta_key, $meta_value, $meta_type)
{
    /**
     * Filter 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 $meta_type  Meta type.
     */
    return apply_filters("sanitize_{$meta_type}_meta_{$meta_key}", $meta_value, $meta_key, $meta_type);
}

WordPress Version: 3.7

/**
 * Sanitize meta value
 *
 * @since 3.1.3
 *
 * @param string $meta_key Meta key
 * @param mixed $meta_value Meta value to sanitize
 * @param string $meta_type Type of meta
 * @return mixed Sanitized $meta_value
 */
function sanitize_meta($meta_key, $meta_value, $meta_type)
{
    return apply_filters("sanitize_{$meta_type}_meta_{$meta_key}", $meta_value, $meta_key, $meta_type);
}