validate_user_signup(): bool

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Return value

bool

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

Performance profile

How much work a call to validate_user_signup() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

15–27

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 38.

Plugin surface

1 hook

Third-party callbacks on 'add_signup_meta' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach option, transient, query, cache, serialize and http. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 3 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost validate_user_signup() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while validate_user_signup() runs, in this order:

1. 1
   apply_filters( add_signup_meta )filterline 695 (+17 into the body)

   Filters the new default site meta variables.

Uses · 6

• validate_user_form()Validates user sign-up name and email.
• signup_user()Shows a form for a visitor to sign up for a new user account.
• signup_blog()Shows a form for a user or visitor to sign up for a new site.
• wpmu_signup_user()Records user signup information for future activation.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• confirm_user_signup()Shows a message confirming that the new user has been registered and is awaiting activation.

Source code

View on Trac ↗View on GitHub ↗

678function validate_user_signup() {679	$result     = validate_user_form();680	$user_name  = $result['user_name'];681	$user_email = $result['user_email'];682	$errors     = $result['errors'];683 684	if ( $errors->has_errors() ) {685		signup_user( $user_name, $user_email, $errors );686		return false;687	}688 689	if ( 'blog' === $_POST['signup_for'] ) {690		signup_blog( $user_name, $user_email );691		return false;692	}693 694	/** This filter is documented in wp-signup.php */695	wpmu_signup_user( $user_name, $user_email, apply_filters( 'add_signup_meta', array() ) );696 697	confirm_user_signup( $user_name, $user_email );698	return true;699}

Changelog

Introduced in MU (3.0.0). Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-signup.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.