update_site_meta( int $site_id, string $meta_key, mixed $meta_value, mixed $prev_value = '' ): int|bool

Updates metadata for a site.


Use the $prev_value parameter to differentiate between meta fields with the same key and site ID.

If the meta field for the site does not exist, it will be added.

Top ↑


$site_id int Required
Site ID.
$meta_key string Required
Metadata key.
$meta_value mixed Required
Metadata value. Must be serializable if non-scalar.
$prev_value mixed Optional
Previous value to check before updating.
If specified, only update existing metadata entries with this value. Otherwise, update all entries.

Default: ''

Top ↑


int|bool Meta ID if the key didn't exist, true on successful update, false on failure or if the value passed to the function is the same as the one that is already in the database.

Top ↑


File: wp-includes/ms-site.php. View all references

function update_site_meta( $site_id, $meta_key, $meta_value, $prev_value = '' ) {
	return update_metadata( 'blog', $site_id, $meta_key, $meta_value, $prev_value );

Top ↑


Version Description
5.1.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.