Summery Summery

Updates metadata for a site.

Syntax Syntax

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

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.

Parameters Parameters


(Required) Site ID.


(Required) Metadata key.


(Required) Metadata value. Must be serializable if non-scalar.


(Optional) Previous value to check before removing.

Default value: ''

Return Return

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

Source Source

File: wp-includes/ms-site.php

 * @since 5.1.0
 * @param int    $site_id    Site ID.


Changelog Changelog

Version Description
5.1.0 Introduced.


Leave a Reply