add_site_meta() WordPress Function

The add_site_meta() function is used to add meta data to a site. The function takes two arguments: the key of the meta data and the value of the meta data. The key can be any string, but the value must be a string or an array.

add_site_meta( int $site_id, string $meta_key, mixed $meta_value, bool $unique = false ) #

Adds metadata to a site.


Parameters

$site_id

(int)(Required)Site ID.

$meta_key

(string)(Required)Metadata name.

$meta_value

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

$unique

(bool)(Optional) Whether the same key should not be added.

Default value: false


Top ↑

Return

(int|false) Meta ID on success, false on failure.


Top ↑

Source

File: wp-includes/ms-site.php

function add_site_meta( $site_id, $meta_key, $meta_value, $unique = false ) {
	return add_metadata( 'blog', $site_id, $meta_key, $meta_value, $unique );
}


Top ↑

Changelog

Changelog
VersionDescription
5.1.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.