update_blog_status( int $blog_id, string $pref, string $value, null $deprecated = null ): string|false

Compatibility

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

Parameters

$blog_idint

Blog ID.

$prefstring

Field name.

$valuestring

Field value.

$deprecatednulloptional

Not used.Default: null

Return value

string|false

$value

Performance profile

How much work a call to update_blog_status() 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

10–24

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

3

3 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksdo_action()one call below update_blog_status()

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

What one call costs · 4 distinct outcomes

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

Uses · 3

• _deprecated_argument()Marks a function argument as deprecated and inform when it has been used.
• wp_update_site()Updates a site in the database.
• is_wp_error()Checks whether the given variable is a WordPress Error.

Used by · 3

• update_archived()Updates the 'archived' status of a particular blog.
• update_blog_public()Updates this blog's 'public' setting in the global blogs table.
• wpmu_delete_blog()Deletes a site.

Source code

View on Trac ↗View on GitHub ↗

764function update_blog_status( $blog_id, $pref, $value, $deprecated = null ) {765	global $wpdb;766 767	if ( null !== $deprecated ) {768		_deprecated_argument( __FUNCTION__, '3.1.0' );769	}770 771	$allowed_field_names = array( 'site_id', 'domain', 'path', 'registered', 'last_updated', 'public', 'archived', 'mature', 'spam', 'deleted', 'lang_id' );772 773	if ( ! in_array( $pref, $allowed_field_names, true ) ) {774		return $value;775	}776 777	$result = wp_update_site(778		$blog_id,779		array(780			$pref => $value,781		)782	);783 784	if ( is_wp_error( $result ) ) {785		return false;786	}787 788	return $value;789}

Changelog

Introduced in 5.1.0. One change between 6.7.7 and 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-blogs.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.