get_blog_option() — описание функции WordPress на русском

Сигнатура

get_blog_option( int $id, string $option, mixed $default_value = false ): mixed

Описание

Если опция не существует или не имеет значения, возвращаемое значение будет false. Это удобно для проверки того, нужно ли устанавливать опцию, и обычно используется при установке опций плагина и для проверки необходимости обновления.
Если опция была сериализована, при возврате она будет десериализована.

Оригинал (английский)

If the option does not exist or does not have a value, then the return value will be false. This is useful to check whether you need to install an option and is commonly used during installation of plugin options and to test whether upgrading is required.

If the option was serialized then it will be unserialized when it is returned.

Параметры

$id int обязательный

ID блога. Может быть null для указания на текущий блог.

$option string обязательный

Имя получаемой опции. Не должно быть экранировано для SQL.

$default_value mixed необязательный = false

Значение по умолчанию, возвращаемое, если опция не существует.

Возвращаемое значение

mixed

Исходный код

wp-includes/ms-blogs.php:357

function get_blog_option( $id, $option, $default_value = false ) {
	$id = (int) $id;

	if ( empty( $id ) ) {
		$id = get_current_blog_id();
	}

	if ( get_current_blog_id() === $id ) {
		return get_option( $option, $default_value );
	}

	switch_to_blog( $id );
	$value = get_option( $option, $default_value );
	restore_current_blog();

	/**
	 * Filters a blog option value.
	 *
	 * The dynamic portion of the hook name, `$option`, refers to the blog option name.
	 *
	 * @since 3.5.0
	 *
	 * @param string  $value The option value.
	 * @param int     $id    Blog ID.
	 */
	return apply_filters( "blog_option_{$option}", $value, $id );
}

История изменений

Версия	Описание
MU (3.0.0)	Introduced.