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

Updates metadata for a site.


Description Description

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 ↑

Parameters Parameters

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

Default value: ''


Top ↑

Return Return

(int|bool) Meta ID if the key didn't exist, true on successful update, false on failure.



Top ↑

Source Source

File: wp-includes/ms-site.php

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 ↑

Changelog Changelog

Changelog
Version Description
5.1.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

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