sanitize_meta() - WordPress 函数参考中文文档

返回介绍

sanitize_meta()

发布于 2017-09-11 字数2824 浏览 935 评论 0

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

Sanitize meta value.


描述


参数

$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.


返回值

(mixed) Sanitized $meta_value.


源代码

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 );
}

更新日志

Version 描述
3.1.3 Introduced.

相关函数

Uses

  • wp-includes/meta.php:
    sanitize_{$object_type}_meta_{$meta_key}
  • wp-includes/plugin.php:
    apply_filters()

Used By

  • wp-includes/meta.php:
    update_metadata_by_mid()
  • wp-includes/meta.php:
    add_metadata()
  • wp-includes/meta.php:
    update_metadata()

User Contributed Notes

  1. Skip to note content

    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

    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' );
    

上一篇:sanitize_key()

下一篇:sanitize_mime_type()

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

目前还没有任何评论,快来抢沙发吧!