delete_site_meta() WordPress Function
The delete_site_meta() function allows you to delete a site meta value. A site meta value is a piece of data associated with a site. The function takes two parameters: the meta key and the site ID. The meta key is the identifier for the site meta value. The site ID is the ID of the site for which you want to delete the meta value.
delete_site_meta( int $site_id, string $meta_key, mixed $meta_value = '' ) #
Removes metadata matching criteria from a site.
Description
You can match based on the key, or key and value. Removing based on key and value, will keep from removing duplicate metadata with the same key. It also allows removing all metadata matching key, if needed.
Parameters
- $site_id
(int)(Required)Site ID.
- $meta_key
(string)(Required)Metadata name.
- $meta_value
(mixed)(Optional) Metadata value. If provided, rows will only be removed that match the value. Must be serializable if non-scalar.
Default value: ''
Return
(bool) True on success, false on failure.
Source
File: wp-includes/ms-site.php
function delete_site_meta( $site_id, $meta_key, $meta_value = '' ) {
return delete_metadata( 'blog', $site_id, $meta_key, $meta_value );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 5.1.0 | Introduced. |