函数文档

validate_user_signup()

💡 云策文档标注

概述

validate_user_signup() 函数用于验证新用户注册,根据验证结果处理用户或站点注册流程,并返回布尔值表示验证成功与否。

关键要点

  • 函数返回布尔值:验证成功返回 true,错误时返回 false。
  • 调用 validate_user_form() 获取用户名、邮箱和错误信息。
  • 根据错误状态或注册类型(用户或站点)调用相应函数,如 signup_user()、signup_blog() 或 wpmu_signup_user()。
  • 使用 apply_filters('add_signup_meta', array()) 钩子过滤新站点的元数据。

代码示例

function validate_user_signup() {
    $result     = validate_user_form();
    $user_name  = $result['user_name'];
    $user_email = $result['user_email'];
    $errors     = $result['errors'];

    if ( $errors->has_errors() ) {
        signup_user( $user_name, $user_email, $errors );
        return false;
    }

    if ( 'blog' === $_POST['signup_for'] ) {
        signup_blog( $user_name, $user_email );
        return false;
    }

    /** This filter is documented in wp-signup.php */
    wpmu_signup_user( $user_name, $user_email, apply_filters( 'add_signup_meta', array() ) );

    confirm_user_signup( $user_name, $user_email );
    return true;
}

注意事项

  • 函数在 WordPress MU 3.0.0 版本中引入,适用于多站点环境。
  • 相关函数包括 validate_user_form()、signup_user()、signup_blog()、confirm_user_signup() 和 wpmu_signup_user()。
  • 使用 apply_filters('add_signup_meta', array $meta) 钩子可以自定义新站点的元变量。

📄 原文内容

Validates the new user sign-up.

Return

bool True if new user sign-up was validated, false on error.

Source

function validate_user_signup() {
	$result     = validate_user_form();
	$user_name  = $result['user_name'];
	$user_email = $result['user_email'];
	$errors     = $result['errors'];

	if ( $errors->has_errors() ) {
		signup_user( $user_name, $user_email, $errors );
		return false;
	}

	if ( 'blog' === $_POST['signup_for'] ) {
		signup_blog( $user_name, $user_email );
		return false;
	}

	/** This filter is documented in wp-signup.php */
	wpmu_signup_user( $user_name, $user_email, apply_filters( 'add_signup_meta', array() ) );

	confirm_user_signup( $user_name, $user_email );
	return true;
}

Hooks

apply_filters( ‘add_signup_meta’, array $meta )

Filters the new default site meta variables.

Changelog

Version Description
MU (3.0.0) Introduced.