sanitize_user()

sanitize_user( string $username, bool $strict = false )…

sanitize_user( string $username, bool $strict = false )

清理用户名,去掉不安全的字符。
Sanitizes a username, stripping out unsafe characters.

目录锚点:#说明#参数#源码#笔记


说明(Description)

删除标记、八位字节、实体,如果启用了strict,则只保留字母数字、u、空格、.、-、@。清理后,它将用户名、原始用户名(参数中的用户名)和$strict值作为“sanitize_user”过滤器的参数。


参数(Parameters)

参数 类型 说明
$username (string) 要清除的用户名。
$strict (bool) 如果设置,则将$username限制为特定字符。

源码(Source)

/**
 * Sanitizes a username, stripping out unsafe characters.
 *
 * Removes tags, octets, entities, and if strict is enabled, will only keep
 * alphanumeric, _, space, ., -, @. After sanitizing, it passes the username,
 * raw username (the username in the parameter), and the value of $strict as
 * parameters for the 'sanitize_user' filter.
 *
 * @since 2.0.0
 *
 * @param string $username The username to be sanitized.
 * @param bool   $strict   If set limits $username to specific characters. Default false.
 * @return string The sanitized username, after passing through filters.
 */
function sanitize_user( $username, $strict = false ) {
	$raw_username = $username;
	$username = wp_strip_all_tags( $username );
	$username = remove_accents( $username );
	// Kill octets
	$username = preg_replace( '|%([a-fA-F0-9][a-fA-F0-9])|', '', $username );
	$username = preg_replace( '/&.+?;/', '', $username ); // Kill entities

	// If strict, reduce to ASCII for max portability.
	if ( $strict )
		$username = preg_replace( '|[^a-z0-9 _.-@]|i', '', $username );

	$username = trim( $username );
	// Consolidate contiguous whitespace
	$username = preg_replace( '|s+|', ' ', $username );

	/**
	 * Filter a sanitized username string.
	 *
	 * @since 2.0.1
	 *
	 * @param string $username     Sanitized username.
	 * @param string $raw_username The username prior to sanitization.
	 * @param bool   $strict       Whether to limit the sanitization to specific characters. Default false.
	 */
	return apply_filters( 'sanitize_user', $username, $raw_username, $strict );
}
更新版本 源码位置 使用 被使用
2.0.0 wp-includes/formatting.php 18 5

笔记(Notes)

以下是此函数的基本示例:

类别:WordPress 函数手册

本文收集自互联网,转载请注明来源。
如有侵权,请联系 wper_net@163.com 删除。

评论 (0)COMMENT

登录 账号发表你的看法,还没有账号?立即免费 注册