update_site_meta( int $site_id, string $meta_key, mixed $meta_value, mixed $prev_value = '' ): int|bool
Updates metadata for a site.
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.
Parameters
-
$site_idint Required -
Site ID.
-
$meta_keystring Required -
Metadata key.
-
$meta_valuemixed Required -
Metadata value. Must be serializable if non-scalar.
-
$prev_valuemixed Optional -
Previous value to check before updating.
If specified, only update existing metadata entries with this value. Otherwise, update all entries.Default:
''
Return
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.
Source
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 );
}
Changelog
| Version | Description |
|---|---|
| 5.1.0 | Introduced. |