WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

update_site_meta()

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

In this article

Back to top

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_idintrequired
Site ID.
$meta_keystringrequired
Metadata key.
$meta_valuemixedrequired
Metadata value. Must be serializable if non-scalar.
$prev_valuemixedoptional
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

function update_site_meta( $site_id, $meta_key, $meta_value, $prev_value = '' ) {
	return update_metadata( 'blog', $site_id, $meta_key, $meta_value, $prev_value );
}

View all references View on Trac View on GitHub

UsesDescription
update_metadata()wp-includes/meta.php

Updates metadata for the specified object. If no value already exists for the specified object ID and metadata key, the metadata will be added.

Used byDescription
wp_upgrade()wp-admin/includes/upgrade.php

Runs WordPress Upgrade functions.

Changelog

VersionDescription
5.1.0Introduced.

User Contributed Notes

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