wppaste
WordPress

delete_site_meta( int $site_id, string $meta_key, mixed $meta_value = '' ): bool

Since
5.1.0
Source
wp-includes/ms-site.php:1064
Removes metadata matching criteria from a site.

Description

You can match based on the key, or key and value. Removing based on key and value, will keep from removing duplicate metadata with the same key. It also allows removing all metadata matching key, if needed.

For historical reasons both the meta key and the meta value are expected to be "slashed" (slashes escaped) on input.

Compatibility

WordPress
since 5.1.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Parameters

$site_idint
Site ID.
$meta_keystring
Metadata name.
$meta_valuemixedoptional
Metadata value. If provided, rows will only be removed that match the value.
Must be serializable if non-scalar. Default empty.Default: ''

Return value

bool
True on success, false on failure.

Performance profile

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

Only touches the object cache, via wp_cache_delete_multiple().

Scaling
Constant

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

Instructions
10

Executed per call on PHP 8.5. The body compiles to 10.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

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

What it touches

  • hookthird-party callbacksapply_filters()one call below delete_site_meta()
  • serializeserialisationmaybe_serialize()one call below delete_site_meta()
  • cacheobject cachewp_cache_delete_multiple()one call below delete_site_meta()

What one call costs · 1 distinct outcome

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

WhenInstructionsCalls it makes
always10delete_metadata()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 10 instructions, 10 executed per call, 0 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 1

Source code

View on Trac View on GitHub 

function delete_site_meta( $site_id, $meta_key, $meta_value = '' ) {	return delete_metadata( 'blog', $site_id, $meta_key, $meta_value );}

Changelog

Introduced in 5.1.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.0.4 tag, from src/wp-includes/ms-site.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.