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 );
} Changelog
| Version | Description |
|---|---|
| 5.1.0 | Introduced. |
© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/delete_site_meta