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–107

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

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 · 25 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 1271 (+66 into the body)

   Fires immediately after a new user is activated.

2. 2
   do_action( wpmu_activate_blog )actionline 1323 (+118 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 ↗

1205function wpmu_activate_signup(1206	#[\SensitiveParameter]1207	$key1208) {1209	global $wpdb;1210 1211	/** @var object{ signup_id: string, domain: string, path: string, title: string, user_login: string, user_email: string, registered: string, activated: string, active: string, activation_key: string, meta: string|null }|null $signup */1212	$signup = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->signups WHERE activation_key = %s", $key ) );1213 1214	if ( empty( $signup ) ) {1215		return new WP_Error( 'invalid_key', __( 'Invalid activation key.' ) );1216	}1217 1218	if ( $signup->active ) {1219		if ( empty( $signup->domain ) ) {1220			return new WP_Error( 'already_active', __( 'The user is already active.' ), $signup );1221		} else {1222			return new WP_Error( 'already_active', __( 'The site is already active.' ), $signup );1223		}1224	}1225 1226	if ( is_string( $signup->meta ) ) {1227		/** @var array<string, mixed> $meta */1228		$meta = maybe_unserialize( $signup->meta );1229	} else {1230		$meta = array();1231	}1232	$password = wp_generate_password( 12, false );1233 1234	$user_id = username_exists( $signup->user_login );1235 1236	if ( ! $user_id ) {1237		$user_id = wpmu_create_user( $signup->user_login, $password, $signup->user_email );1238	} else {1239		$user_already_exists = true;1240	}1241 1242	if ( ! $user_id ) {1243		return new WP_Error( 'create_user', __( 'Could not create user' ), $signup );1244	}1245 1246	$now = current_time( 'mysql', true );1247 1248	if ( empty( $signup->domain ) ) {1249		$wpdb->update(1250			(string) $wpdb->signups,1251			array(1252				'active'    => 1,1253				'activated' => $now,1254			),1255			array( 'activation_key' => $key )1256		);1257 1258		if ( isset( $user_already_exists ) ) {1259			return new WP_Error( 'user_already_exists', __( 'That username is already activated.' ), $signup );1260		}1261 1262		/**1263		 * Fires immediately after a new user is activated.1264		 *1265		 * @since MU (3.0.0)1266		 *1267		 * @param int    $user_id  User ID.1268		 * @param string $password User password.1269		 * @param array  $meta     Signup meta data.1270		 */1271		do_action( 'wpmu_activate_user', $user_id, $password, $meta );1272 1273		return array(1274			'user_id'  => $user_id,1275			'password' => $password,1276			'meta'     => $meta,1277		);1278	}1279 1280	$blog_id = wpmu_create_blog( $signup->domain, $signup->path, $signup->title, $user_id, $meta, get_current_network_id() );1281 1282	// TODO: What to do if we create a user but cannot create a blog?1283	if ( is_wp_error( $blog_id ) ) {1284		/*

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-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.