get_option

Получает значение указанной настройки (опции).

Функция получает данные из кэша, если это возможно, если нет, то данные берутся из Базы Данных.

✈ 1 раз = 0.000018с = очень быстро | 50000 раз = 0.17с = очень быстро PHP 7.0.5, WP 4.5.2
Хуки из функции:
default_option_(option)
option_(option)
pre_option_(option)
Возвращает

Разное/false. Значение опции или false, если указанной опции не существует или не удалось получить её значение

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

get_option( $option, $default );
$option(строка) (обязательный)

Название опции, значение которой нужно получить. Некоторые из доступных опций:

  • admin_email – E-mail администратора блога.
  • blogname – название блога. Устанавливается в настройках.
  • blogdescription – описание блога. Устанавливается в настройках.
  • blog_charset – Кодировка блога. Устанавливается в настройках.
  • date_format – формат даты. Устанавливается в настройках.
  • default_category – категория постов по умолчанию. Устанавливается в настройках.
  • home – Адрес домашней страницы блога. Устанавливается в основных настройках.
  • siteurl – Адрес WordPress. Устанавливается в основных настройках.

    Заметка: siteurl отличается от get_bloginfo('siteurl') (который возвращает url домашней страницы блога). И не отличается от get_bloginfo('wpurl').
  • template – название текущей темы.
  • start_of_week – день с которого начинается неделя. Устанавливается в основных настройках.
  • upload_path – каталог загрузки по умолчанию.  Устанавливается в настройках.
  • posts_per_page – максимальное число постов на странице.  Устанавливается в настройках чтения.
  • posts_per_rss –  максимальное число постов выводимых в фид.  Устанавливается в настройках чтения.

    Полный список опций смотрите в кодексе WordPress.

По умолчанию: нет

$default(строка/число/логический)
Значение по умолчанию, которое нужно вернуть, если не удалось получить опцию (если опции в БД не существует).
По умолчанию: false

Примеры

#1. Выведем название блога в теге H1:

$admin_email = get_option('admin_email');

Код из


wp-includes/option.php

WP 4.7.3

<?php
function get_option( $option, $default = false ) {
	global $wpdb;

	$option = trim( $option );
	if ( empty( $option ) )
		return false;

	/**
	 * Filters the value of an existing option before it is retrieved.
	 *
	 * The dynamic portion of the hook name, `$option`, refers to the option name.
	 *
	 * Passing a truthy value to the filter will short-circuit retrieving
	 * the option value, returning the passed value instead.
	 *
	 * @since 1.5.0
	 * @since 4.4.0 The `$option` parameter was added.
	 *
	 * @param bool|mixed $pre_option Value to return instead of the option value.
	 *                               Default false to skip it.
	 * @param string     $option     Option name.
	 */
	$pre = apply_filters( "pre_option_{$option}", false, $option );
	if ( false !== $pre )
		return $pre;

	if ( defined( 'WP_SETUP_CONFIG' ) )
		return false;

	// Distinguish between `false` as a default, and not passing one.
	$passed_default = func_num_args() > 1;

	if ( ! wp_installing() ) {
		// prevent non-existent options from triggering multiple queries
		$notoptions = wp_cache_get( 'notoptions', 'options' );
		if ( isset( $notoptions[ $option ] ) ) {
			/**
			 * Filters the default value for an option.
			 *
			 * The dynamic portion of the hook name, `$option`, refers to the option name.
			 *
			 * @since 3.4.0
			 * @since 4.4.0 The `$option` parameter was added.
			 * @since 4.7.0 The `$passed_default` parameter was added to distinguish between a `false` value and the default parameter value.
			 *
			 * @param mixed  $default The default value to return if the option does not exist
			 *                        in the database.
			 * @param string $option  Option name.
			 * @param bool   $passed_default Was `get_option()` passed a default value?
			 */
			return apply_filters( "default_option_{$option}", $default, $option, $passed_default );
		}

		$alloptions = wp_load_alloptions();

		if ( isset( $alloptions[$option] ) ) {
			$value = $alloptions[$option];
		} else {
			$value = wp_cache_get( $option, 'options' );

			if ( false === $value ) {
				$row = $wpdb->get_row( $wpdb->prepare( "SELECT option_value FROM $wpdb->options WHERE option_name = %s LIMIT 1", $option ) );

				// Has to be get_row instead of get_var because of funkiness with 0, false, null values
				if ( is_object( $row ) ) {
					$value = $row->option_value;
					wp_cache_add( $option, $value, 'options' );
				} else { // option does not exist, so we must cache its non-existence
					if ( ! is_array( $notoptions ) ) {
						 $notoptions = array();
					}
					$notoptions[$option] = true;
					wp_cache_set( 'notoptions', $notoptions, 'options' );

					/** This filter is documented in wp-includes/option.php */
					return apply_filters( 'default_option_' . $option, $default, $option, $passed_default );
				}
			}
		}
	} else {
		$suppress = $wpdb->suppress_errors();
		$row = $wpdb->get_row( $wpdb->prepare( "SELECT option_value FROM $wpdb->options WHERE option_name = %s LIMIT 1", $option ) );
		$wpdb->suppress_errors( $suppress );
		if ( is_object( $row ) ) {
			$value = $row->option_value;
		} else {
			/** This filter is documented in wp-includes/option.php */
			return apply_filters( 'default_option_' . $option, $default, $option, $passed_default );
		}
	}

	// If home is not set use siteurl.
	if ( 'home' == $option && '' == $value )
		return get_option( 'siteurl' );

	if ( in_array( $option, array('siteurl', 'home', 'category_base', 'tag_base') ) )
		$value = untrailingslashit( $value );

	/**
	 * Filters the value of an existing option.
	 *
	 * The dynamic portion of the hook name, `$option`, refers to the option name.
	 *
	 * @since 1.5.0 As 'option_' . $setting
	 * @since 3.0.0
	 * @since 4.4.0 The `$option` parameter was added.
	 *
	 * @param mixed  $value  Value of the option. If stored serialized, it will be
	 *                       unserialized prior to being returned.
	 * @param string $option Option name.
	 */
	return apply_filters( "option_{$option}", maybe_unserialize( $value ), $option );
}