wpmu_activate_signup( string $key ): array|WP_Error

Description

Compatibility

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

Parameters

$keystring

The activation key provided to the user.

Return value

array|WP_Error

An array containing information about the activated user and/or blog.

Performance profile

How much work a call to wpmu_activate_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

Heavy

Reaches the database via ->get_row().

Scaling

Constant

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

Instructions

24–103

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

Plugin surface

2 hooks

Third-party callbacks on 'wpmu_activate_user', 'wpmu_activate_blog' 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

• serializeserialisationmaybe_unserialize()called directly
• hookthird-party callbacksdo_action()called directly
• sqldatabase query->get_row()called directly
• querycontent queryget_user_by()one call below wpmu_activate_signup()
• optionoption read or writeget_option()one call below wpmu_activate_signup()
• cacheobject cachewp_cache_set_sites_last_changed()one call below wpmu_activate_signup()

Further down the call graph this can also reach transient. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 13 distinct outcomes

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

Hooks and filters fired · 2

2 hooks fire while wpmu_activate_signup() runs, in this order:

1. 1
   do_action( wpmu_activate_user )actionline 1253 (+60 into the body)

   Fires immediately after a new user is activated.

2. 2
   do_action( wpmu_activate_blog )actionline 1305 (+112 into the body)

   Fires immediately after a site is activated.

Uses · 11

• __()Retrieves the translation of $text.
• maybe_unserialize()Unserializes data only if it was serialized.
• wp_generate_password()Generates a random password drawn from the defined set of characters.
• username_exists()Determines whether the given username exists.
• wpmu_create_user()Creates a user.
• current_time()Retrieves the current time based on specified type.
• do_action()Calls the callback functions that have been added to an action hook.
• wpmu_create_blog()Creates a site.
• get_current_network_id()Retrieves the current network ID.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• WP_Error::__construct()Initializes the error.

Source code

View on Trac ↗View on GitHub ↗

1193function wpmu_activate_signup(1194	#[\SensitiveParameter]1195	$key1196) {1197	global $wpdb;1198 1199	$signup = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->signups WHERE activation_key = %s", $key ) );1200 1201	if ( empty( $signup ) ) {1202		return new WP_Error( 'invalid_key', __( 'Invalid activation key.' ) );1203	}1204 1205	if ( $signup->active ) {1206		if ( empty( $signup->domain ) ) {1207			return new WP_Error( 'already_active', __( 'The user is already active.' ), $signup );1208		} else {1209			return new WP_Error( 'already_active', __( 'The site is already active.' ), $signup );1210		}1211	}1212 1213	$meta     = maybe_unserialize( $signup->meta );1214	$password = wp_generate_password( 12, false );1215 1216	$user_id = username_exists( $signup->user_login );1217 1218	if ( ! $user_id ) {1219		$user_id = wpmu_create_user( $signup->user_login, $password, $signup->user_email );1220	} else {1221		$user_already_exists = true;1222	}1223 1224	if ( ! $user_id ) {1225		return new WP_Error( 'create_user', __( 'Could not create user' ), $signup );1226	}1227 1228	$now = current_time( 'mysql', true );1229 1230	if ( empty( $signup->domain ) ) {1231		$wpdb->update(1232			$wpdb->signups,1233			array(1234				'active'    => 1,1235				'activated' => $now,1236			),1237			array( 'activation_key' => $key )1238		);1239 1240		if ( isset( $user_already_exists ) ) {1241			return new WP_Error( 'user_already_exists', __( 'That username is already activated.' ), $signup );1242		}1243 1244		/**1245		 * Fires immediately after a new user is activated.1246		 *1247		 * @since MU (3.0.0)1248		 *1249		 * @param int    $user_id  User ID.1250		 * @param string $password User password.1251		 * @param array  $meta     Signup meta data.1252		 */1253		do_action( 'wpmu_activate_user', $user_id, $password, $meta );1254 1255		return array(1256			'user_id'  => $user_id,1257			'password' => $password,1258			'meta'     => $meta,1259		);1260	}1261 1262	$blog_id = wpmu_create_blog( $signup->domain, $signup->path, $signup->title, $user_id, $meta, get_current_network_id() );1263 1264	// TODO: What to do if we create a user but cannot create a blog?1265	if ( is_wp_error( $blog_id ) ) {1266		/*1267		 * If blog is taken, that means a previous attempt to activate this blog1268		 * failed in between creating the blog and setting the activation flag.1269		 * Let's just set the active flag and instruct the user to reset their password.1270		 */1271		if ( 'blog_taken' === $blog_id->get_error_code() ) {1272			$blog_id->add_data( $signup );

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 6.9.7 tag, from src/wp-includes/ms-functions.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.