get_site_option( string $option, mixed $default = false, bool $deprecated = true )

Retrieve an option value for the current network based on name of option.


Description Description

See also See also


Top ↑

Parameters Parameters

$option

(string) (Required) Name of the option to retrieve. Expected to not be SQL-escaped.

$default

(mixed) (Optional) Value to return if the option doesn't exist.

Default value: false

$deprecated

(bool) (Optional) Whether to use cache. Multisite only. Always set to true.

Default value: true


Top ↑

Return Return

(mixed) Value set for the option.


Top ↑

More Information More Information

This function is almost identical to get_option(), except that in multisite, it returns the network-wide option. For non-multisite installs, it uses get_option.

It is easy to get confused about the difference between get_option() and get_site_option(), because multisite used different terms before. Now there are different “sites” on a “network”, before there where different “blogs” on a “site”. Many functions and variables were introduced before this change, such as this one. Think of this function as “get_network_option()


Top ↑

Source Source

File: wp-includes/option.php

function get_site_option( $option, $default = false, $deprecated = true ) {
	return get_network_option( null, $option, $default );
}


Top ↑

Changelog Changelog

Changelog
Version Description
4.4.0 Modified into wrapper for get_network_option()
2.8.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

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