update_site_meta

SummerySummery

Updates metadata for a site.

Syntax

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

DescriptionDescription

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.

ParametersParameters

$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: ''

ReturnReturn

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

SourceSource

File: wp-includes/ms-site.php


			

ChangelogChangelog

Changelog
Version Description
5.1.0 Introduced.
Scroll to Top