get_option

get_option函式是一個WordPress函式，它從資料庫中檢索一個選項值。WordPress中的選項是可以由使用者設定和調整的設定: 這個函式接受一個引數，它是你想檢索的選項的名稱。例如，如果你想檢索”blogname”選項的值，你會呼叫get_option(‘blogname’): 該函式返回該選項的值。

檢索基於選項名稱的選項值。

如果該選項不存在，並且沒有提供預設值。會返回布林值false。這可以用來檢查你是否需要 在安裝外掛的過程中初始化一個選項，然而這 可以通過使用add_option()更好地完成，它將不會覆蓋 現有的選項。

不初始化一個選項並使用布林值”false”作為返回值 是一個不好的做法，因為它會觸發一個額外的資料庫查詢。

返回值的型別可以與儲存或更新選項時傳遞的型別不同。時傳遞的型別不同。如果選項的值被序列化了。那麼當它被返回時，它將被取消序列化。在這種情況下，其型別將 是相同的。例如，儲存一個像陣列一樣的非標量值會 返回相同的陣列。

在大多數情況下，非字串的標量值和空值將被轉換並返回 作為字串的等價物。

例外的情況：

1. 當選項沒有儲存在資料庫中時，如果提供了”$default”值，就會返回。會被返回。如果沒有，將返回布林值`false`。
2. 當使用選項API過濾器之一時。{@see ‘pre_option_$option’}, {@see ‘default_option_$option’}, or {@see ‘option_$option’}, the return 值可能不符合預期的型別。
3. 當選項剛剛被儲存在資料庫中，並且get_option() 之後，非字串的標量值和空值不會被轉換為等同於字串的值。字串等價物，並返回原始型別。

示例：

當像這樣新增選項時。`add_option( ‘my_option_name’, ‘value’)`這樣新增選項時。然後用`get_option( ‘my_option_name’)`來獲取它們，返回的 返回的值將是：

– `false` returns `string(0)””`
– `true` returns `string(1)”1″`
– `0` returns `string(1)”0″`
– `1` returns `string(1)”1″`
– `’0’` returns `string(1)”0″`
– `’1’` returns `string(1)”1″`
– `null` returns `string(0)””`

當新增非標量值的選項時，如 `add_option( ‘my_array’, array( false, ‘str’, null )`, 返回值 將與原始值相同，因為它在儲存到資料庫之前被序列化了 它被序列化後儲存在資料庫中：

array(3) {
[0] => bool(false)
[1] => string(3)”str”
[2] => NULL
}

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

	if ( is_scalar( $option ) ) {
		$option = trim( $option );
	}

	if ( empty( $option ) ) {
		return false;
	}

	/*
	 * Until a proper _deprecated_option() function can be introduced,
	 * redirect requests to deprecated keys to the new, correct ones.
	 */
	$deprecated_keys = array(
		'blacklist_keys'    => 'disallowed_keys',
		'comment_whitelist' => 'comment_previously_approved',
	);

	if ( isset( $deprecated_keys[ $option ] ) && ! wp_installing() ) {
		_deprecated_argument(
			__FUNCTION__,
			'5.5.0',
			sprintf(
				/* translators: 1: Deprecated option key, 2: New option key. */
				__( 'The "%1$s" option key has been renamed to "%2$s".' ),
				$option,
				$deprecated_keys[ $option ]
			)
		);
		return get_option( $deprecated_keys[ $option ], $default );
	}

	/**
	 * Filters the value of an existing option before it is retrieved.
	 *
	 * The dynamic portion of the hook name, `$option`, refers to the option name.
	 *
	 * Returning a value other than false from the filter will short-circuit retrieval
	 * and return that value instead.
	 *
	 * @since 1.5.0
	 * @since 4.4.0 The `$option` parameter was added.
	 * @since 4.9.0 The `$default` parameter was added.
	 *
	 * @param mixed  $pre_option The value to return instead of the option value. This differs
	 *                           from `$default`, which is used as the fallback value in the event
	 *                           the option doesn't exist elsewhere in get_option().
	 *                           Default false (to skip past the short-circuit).
	 * @param string $option     Option name.
	 * @param mixed  $default    The fallback value to return if the option does not exist.
	 *                           Default false.
	 */
	$pre = apply_filters( "pre_option_{$option}", false, $option, $default );

	/**
	 * Filters the value of all existing options before it is retrieved.
	 *
	 * Returning a truthy value from the filter will effectively short-circuit retrieval
	 * and return the passed value instead.
	 *
	 * @since 6.1.0
	 *
	 * @param mixed  $pre_option  The value to return instead of the option value. This differs
	 *                            from `$default`, which is used as the fallback value in the event
	 *                            the option doesn't exist elsewhere in get_option().
	 *                            Default false (to skip past the short-circuit).
	 * @param string $option      Name of the option.
	 * @param mixed  $default     The fallback value to return if the option does not exist.
	 *                            Default false.
	 */
	$pre = apply_filters( 'pre_option', $pre, $option, $default );

	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' );

		// Prevent non-existent `notoptions` key from triggering multiple key lookups.
		if ( ! is_array( $notoptions ) ) {
			$notoptions = array();
			wp_cache_set( 'notoptions', $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' ), true ) ) {
		$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 );
}