云策 WordPress 开发者社区

函数文档

validate_username()

查看官方原文 ↗
💡 云策文档标注

概述

validate_username() 函数用于检查用户名是否有效，通过调用 sanitize_user() 进行清理并比较结果。开发者可利用 'validate_username' Hook 添加自定义验证逻辑。

关键要点

  • 参数：$username（字符串，必需），表示待检查的用户名
  • 返回值：布尔值，指示用户名是否有效
  • 核心逻辑：使用 sanitize_user() 清理用户名，若清理后与原始用户名一致且非空，则视为有效
  • Hook：提供 'validate_username' 过滤器，允许开发者修改验证结果
  • 相关函数：sanitize_user() 用于清理用户名，apply_filters() 用于调用过滤器
  • 变更记录：从 4.4.0 版本起，清理后为空用户名被视为无效

代码示例

if ( ! empty( $_POST['username'] ) && validate_username( $_POST['username'] ) ) {
    // Go ahead and save the user...
}
📄 原文内容

Checks whether a username is valid.

Parameters

$usernamestringrequired
Username.

Return

bool Whether username given is valid.

More Information

This function attempts to sanitize the username, and if it “passes”, the name is considered valid. For additional logic, you can use the ‘validate_username‘ hook.

Source

function validate_username( $username ) {
	$sanitized = sanitize_user( $username, true );
	$valid     = ( $sanitized === $username && ! empty( $sanitized ) );

	/**
	 * Filters whether the provided username is valid.
	 *
	 * @since 2.0.1
	 *
	 * @param bool   $valid    Whether given username is valid.
	 * @param string $username Username to check.
	 */
	return apply_filters( 'validate_username', $valid, $username );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘validate_username’, bool $valid, string $username )

Filters whether the provided username is valid.

Uses Description
sanitize_user()wp-includes/formatting.php

Sanitizes a username, stripping out unsafe characters.
apply_filters()wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.
Used by Description
WP_REST_Users_Controller::check_username()wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php

Check a username for the REST API.
edit_user()wp-admin/includes/user.php

Edit user settings based on contents of $_POST
register_new_user()wp-includes/user.php

Handles registering a new user.

Changelog

Version Description
4.4.0 Empty sanitized usernames are now considered invalid.
2.0.1 Introduced.

User Contributed Notes