get_site_meta( int $site_id, string $key = '', bool $single = false )
Retrieves metadata for a site.
Parameters
- $site_id
-
(int) (Required) Site ID.
- $key
-
(string) (Optional) The meta key to retrieve. By default, returns data for all keys.
Default value: ''
- $single
-
(bool) (Optional) Whether to return a single value. This parameter has no effect if
$key
is not specified.Default value: false
Return
(mixed) An array of values if $single
is false. The value of meta data field if $single
is true. False for an invalid $site_id
(non-numeric, zero, or negative value). An empty string if a valid but non-existing site ID is passed.
Source
File: wp-includes/ms-site.php
function get_site_meta( $site_id, $key = '', $single = false ) { return get_metadata( 'blog', $site_id, $key, $single ); }
Changelog
Version | Description |
---|---|
5.1.0 | Introduced. |
© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_site_meta