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

Parameters

$site_idint

Site ID.

$keystringoptional

The meta key to retrieve. By default, returns data for all keys. Default empty.Default: ''

$singlebooloptional

Whether to return a single value. This parameter has no effect if $key is not specified. Default false.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.

Uses · 1

• get_metadata()Retrieves the value of a metadata field for the specified object type and ID.

Source

View on Trac ↗View on GitHub ↗

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

History

Introduced in 5.1.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/ms-site.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.