WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

get_site_meta()

get_site_meta( int $site_id, string $key = '', bool $single = false ): mixed

In this article

Back to top

Retrieves metadata for a site.

Parameters

$site_idintrequired
Site ID.
$keystringoptional
The meta key to retrieve. By default, returns data for all keys.

Default:''

$singlebooloptional
Whether to return a single value.
This parameter has no effect if $key is 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 array if a valid but non-existing site ID is passed and $single is false.
An empty string if a valid but non-existing site ID is passed and $single is true.
Note: Non-serialized values are returned as strings:
  • false values are returned as empty strings ('')
  • true values are returned as '1'
  • numbers (both integer and float) are returned as strings Arrays and objects retain their original type.

Source

function get_site_meta( $site_id, $key = '', $single = false ) {
	return get_metadata( 'blog', $site_id, $key, $single );
}

View all references View on Trac View on GitHub

UsesDescription
get_metadata()wp-includes/meta.php

Retrieves the value of a metadata field for the specified object type and ID.

Changelog

VersionDescription
5.1.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.