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 );
}
Changelog
| Version | Description |
|---|---|
| 5.1.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
It should probably be noted that this function is only available on multisite blogs.