On this page
get_site_meta( int $site_id, string $key = '', bool $single = false ): mixed
Retrieves metadata for a site.
Parameters
$site_idint Required-
Site ID.
$keystring Optional-
The meta key to retrieve. By default, returns data for all keys.
Default:
'' $singlebool Optional-
Whether to return a single value.
This parameter has no effect if$keyis not specified.
Default:
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. View all references
function get_site_meta( $site_id, $key = '', $single = false ) {
return get_metadata( 'blog', $site_id, $key, $single );
}
Related
Uses
| Uses | Description |
|---|---|
| get_metadata() wp-includes/meta.php | Retrieves the value of a metadata field for the specified object type and ID. |
Changelog
| Version | Description |
|---|---|
| 5.1.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_site_meta