Функция GET_SITE_OPTION() в WordPress: описание, примеры использования, параметры

# Функция GET_SITE_OPTION() │ WP 2.8.0

Функция get_site_option() позволяет получить значение параметра для текущей сети WordPress по его имени.

### Использует

Данная функция основана на функции get_network_option(). 

### Хуки

Хуков не используется.

## Возврат значений

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

## Использование

```php
get_site_option( $option, $default_value, $deprecated );

Параметры

• $option (строка) (обязательный) — Имя параметра, значение которого нужно получить. Не нужно экранировать для SQL.
• $default_value (смешанный тип) — Значение, которое будет возвращено, если параметр не существует. По умолчанию: false.
• $deprecated (логическое значение) — Указывает, следует ли использовать кэш. Применимо только для мультисайтов. Всегда должно быть установлено в true. По умолчанию: true.

Примеры

Пример 1: Получение электронной почты администратора сети

$admin_email = get_site_option( 'admin_email' );

Пример 2: Получение URL сайта главной сети

echo get_site_option( 'siteurl' );

Пример 3: Установка значения по умолчанию

$value = get_site_option( 'i_dont_exist' );
// $value будет равно false

$value = get_site_option( 'i_dont_exist', 'blah' );
// $value будет равно 'blah'

Добавьте свой пример

Вы можете добавить собственный пример использования функции здесь.

Заметки

• Смотрите: get_network_option() для получения дополнительных сведений.

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

• С версии 2.8.0 — Функция была введена.
• С версии 4.4.0 — Параметр $use_cache стал устаревшим.
• С версии 4.4.0 — Функция была изменена на обертку для get_network_option().

Код функции GET_SITE_OPTION

Функция get_site_option определена в файле:

wp-includes/option.php

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

Связанные функции

API Опций (Настройки)

• add_network_option()
• add_option()
• delete_option()
• get_network_option()
• get_option()
• register_setting()
• update_option()
• update_site_option()

Опции для мультисайтов

• get_site_transient()