sanitize_key()清理 key 字符串

目录

描述

清理 key 字符串,keys 是用来作为内部的标示符。

只允许消息数字和字 ,破折号和下划线。

sanitize_key() 描述

用法

<?php sanitize_key$key ); ?>

sanitize_key() 用法

参数

$key

(string) (必填) 要处 的key字符串

默认 : None

sanitize_key() 参数

返回值

(string) 

处理后的key 符串

sanitize_key() 返回值

注意

Filters

  • 'sanitize_key':
    apply_filters( 'sanitize_key', $key, $raw_key )

sanitize_key() 注意

历史

添加于 版本: 3.0.0

sanitize_key() 历史

源文件

sanitize_key() 函数的代码位于 /wp-includes/formatting.php.

/* ----------------------------------
 * wordpress之魂 © http://wphun.com
 * ---------------------------------- */
/**
 * Sanitizes a string key.
 *
 * Keys are used as internal identifiers. Lowercase alphanumeric characters, dashes and underscores are allowed.
 *
 * @since 3.0.0
 *
 * @param string $key String key
 * @return string Sanitized key
 */
function sanitize_key( $key ) {
	$raw_key = $key;
	$key = strtolower( $key );
	$key = preg_replace( '/[^a-z0-9_-]/', '', $key );

	/**
	 * Filter a sanitized key string.
	 *
	 * @since 3.0.0
	 *
	 * @param string $key     Sanitized key.
	 * @param string $raw_key The key prior to sanitization.
	 */
	return apply_filters( 'sanitize_key', $key, $raw_key );
}

sanitize_key() 源文件