<?php

/**

 * Option API

 *

 * @package WordPress

 */

/**

 * Retrieve option value based on name of option.

 *

 * 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.

 *

 * @since 1.5.0

 * @package WordPress

 * @subpackage Option

 * @uses apply_filters() Calls 'pre_option_$option' before checking the option.

 * 	Any value other than false will "short-circuit" the retrieval of the option

 *	and return the returned value. You should not try to override special options,

 * 	but you will not be prevented from doing so.

 * @uses apply_filters() Calls 'option_$option', after checking the option, with

 * 	the option value.

 *

 * @param string $option Name of option to retrieve. Expected to not be SQL-escaped.

 * @param mixed $default Optional. Default value to return if the option does not exist.

 * @return mixed Value set for the option.

 */

function get_option( $option, $default = false ) {

	global $wpdb;

	$option = trim( $option );

	if ( empty( $option ) )

		return false;

	// Allow plugins to short-circuit options.

	$pre = apply_filters( 'pre_option_' . $option, false );

	if ( false !== $pre )

		return $pre;

	if ( defined( 'WP_SETUP_CONFIG' ) )

		return false;

	if ( ! defined( 'WP_INSTALLING' ) ) {

		// prevent non-existent options from triggering multiple queries

		$notoptions = wp_cache_get( 'notoptions', 'options' );

		if ( isset( $notoptions[$option] ) )

			return apply_filters( 'default_option_' . $option, $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

					$notoptions[$option] = true;

					wp_cache_set( 'notoptions', $notoptions, 'options' );

					return apply_filters( 'default_option_' . $option, $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

			return apply_filters( 'default_option_' . $option, $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 );

	return apply_filters( 'option_' . $option, maybe_unserialize( $value ) );

}

/**

 * Protect WordPress special option from being modified.

 *

 * Will die if $option is in protected list. Protected options are 'alloptions'

 * and 'notoptions' options.

 *

 * @since 2.2.0

 * @package WordPress

 * @subpackage Option

 *

 * @param string $option Option name.

 */

function wp_protect_special_option( $option ) {

	if ( 'alloptions' === $option || 'notoptions' === $option )

		wp_die( sprintf( __( '%s is a protected WP option and may not be modified' ), esc_html( $option ) ) );

}

/**

 * Print option value after sanitizing for forms.

 *

 * @uses attr Sanitizes value.

 * @since 1.5.0

 * @package WordPress

 * @subpackage Option

 *

 * @param string $option Option name.

 */

function form_option( $option ) {

	echo esc_attr( get_option( $option ) );

}

/**

 * Loads and caches all autoloaded options, if available or all options.

 *

 * @since 2.2.0

 * @package WordPress

 * @subpackage Option

 *

 * @return array List of all options.

 */

function wp_load_alloptions() {

	global $wpdb;

	if ( !defined( 'WP_INSTALLING' ) || !is_multisite() )

		$alloptions = wp_cache_get( 'alloptions', 'options' );

	else

		$alloptions = false;

	if ( !$alloptions ) {

		$suppress = $wpdb->suppress_errors();

		if ( !$alloptions_db = $wpdb->get_results( "SELECT option_name, option_value FROM $wpdb->options WHERE autoload = 'yes'" ) )

			$alloptions_db = $wpdb->get_results( "SELECT option_name, option_value FROM $wpdb->options" );

		$wpdb->suppress_errors($suppress);

		$alloptions = array();

		foreach ( (array) $alloptions_db as $o ) {

			$alloptions[$o->option_name] = $o->option_value;

		}

		if ( !defined( 'WP_INSTALLING' ) || !is_multisite() )

			wp_cache_add( 'alloptions', $alloptions, 'options' );

	}

	return $alloptions;

}

/**

 * Loads and caches certain often requested site options if is_multisite() and a persistent cache is not being used.

 *

 * @since 3.0.0

 * @package WordPress

 * @subpackage Option

 *

 * @param int $site_id Optional site ID for which to query the options. Defaults to the current site.

 */

function wp_load_core_site_options( $site_id = null ) {

	global $wpdb;

	if ( !is_multisite() || wp_using_ext_object_cache() || defined( 'WP_INSTALLING' ) )

		return;

	if ( empty($site_id) )

		$site_id = $wpdb->siteid;

	$core_options = array('site_name', 'siteurl', 'active_sitewide_plugins', '_site_transient_timeout_theme_roots', '_site_transient_theme_roots', 'site_admins', 'can_compress_scripts', 'global_terms_enabled', 'ms_files_rewriting' );

	$core_options_in = "'" . implode("', '", $core_options) . "'";

	$options = $wpdb->get_results( $wpdb->prepare("SELECT meta_key, meta_value FROM $wpdb->sitemeta WHERE meta_key IN ($core_options_in) AND site_id = %d", $site_id) );

	foreach ( $options as $option ) {

		$key = $option->meta_key;

		$cache_key = "{$site_id}:$key";

		$option->meta_value = maybe_unserialize( $option->meta_value );

		wp_cache_set( $cache_key, $option->meta_value, 'site-options' );

	}

}

/**

 * Update the value of an option that was already added.

 *

 * You do not need to serialize values. If the value needs to be serialized, then

 * it will be serialized before it is inserted into the database. Remember,

 * resources can not be serialized or added as an option.

 *

 * If the option does not exist, then the option will be added with the option

 * value, but you will not be able to set whether it is autoloaded. If you want

 * to set whether an option is autoloaded, then you need to use the add_option().

 *

 * @since 1.0.0

 * @package WordPress

 * @subpackage Option

 *

 * @uses apply_filters() Calls 'pre_update_option_$option' hook to allow overwriting the

 * 	option value to be stored.

 * @uses do_action() Calls 'update_option' hook before updating the option.

 * @uses do_action() Calls 'update_option_$option' and 'updated_option' hooks on success.

 *

 * @param string $option Option name. Expected to not be SQL-escaped.

 * @param mixed $value Option value. Must be serializable if non-scalar. Expected to not be SQL-escaped.

 * @return bool False if value was not updated and true if value was updated.

 */

function update_option( $option, $value ) {

	global $wpdb;

	$option = trim($option);

	if ( empty($option) )

		return false;

	wp_protect_special_option( $option );

	if ( is_object( $value ) )

		$value = clone $value;

	$value = sanitize_option( $option, $value );

	$old_value = get_option( $option );

	$value = apply_filters( 'pre_update_option_' . $option, $value, $old_value );

	// If the new and old values are the same, no need to update.

	if ( $value === $old_value )

		return false;

	if ( false === $old_value )

		return add_option( $option, $value );

	$serialized_value = maybe_serialize( $value );

	do_action( 'update_option', $option, $old_value, $value );

	$result = $wpdb->update( $wpdb->options, array( 'option_value' => $serialized_value ), array( 'option_name' => $option ) );

	if ( ! $result )

		return false;

	$notoptions = wp_cache_get( 'notoptions', 'options' );

	if ( is_array( $notoptions ) && isset( $notoptions[$option] ) ) {

		unset( $notoptions[$option] );

		wp_cache_set( 'notoptions', $notoptions, 'options' );

	}

	if ( ! defined( 'WP_INSTALLING' ) ) {

		$alloptions = wp_load_alloptions();

		if ( isset( $alloptions[$option] ) ) {

			$alloptions[ $option ] = $serialized_value;

			wp_cache_set( 'alloptions', $alloptions, 'options' );

		} else {

			wp_cache_set( $option, $serialized_value, 'options' );

		}

	}

	do_action( "update_option_{$option}", $old_value, $value );

	do_action( 'updated_option', $option, $old_value, $value );

	return true;

}

/**

 * Add a new option.

 *

 * You do not need to serialize values. If the value needs to be serialized, then

 * it will be serialized before it is inserted into the database. Remember,

 * resources can not be serialized or added as an option.

 *

 * You can create options without values and then update the values later.

 * Existing options will not be updated and checks are performed to ensure that you

 * aren't adding a protected WordPress option. Care should be taken to not name

 * options the same as the ones which are protected.

 *

 * @package WordPress

 * @subpackage Option

 * @since 1.0.0

 *

 * @uses do_action() Calls 'add_option' hook before adding the option.

 * @uses do_action() Calls 'add_option_$option' and 'added_option' hooks on success.

 *

 * @param string $option Name of option to add. Expected to not be SQL-escaped.

 * @param mixed $value Optional. Option value. Must be serializable if non-scalar. Expected to not be SQL-escaped.

 * @param mixed $deprecated Optional. Description. Not used anymore.

 * @param bool $autoload Optional. Default is enabled. Whether to load the option when WordPress starts up.

 * @return bool False if option was not added and true if option was added.

 */

function add_option( $option, $value = '', $deprecated = '', $autoload = 'yes' ) {

	global $wpdb;

	if ( !empty( $deprecated ) )

		_deprecated_argument( __FUNCTION__, '2.3' );

	$option = trim($option);

	if ( empty($option) )

		return false;

	wp_protect_special_option( $option );

	if ( is_object($value) )

		$value = clone $value;

	$value = sanitize_option( $option, $value );

	// Make sure the option doesn't already exist. We can check the 'notoptions' cache before we ask for a db query

	$notoptions = wp_cache_get( 'notoptions', 'options' );

	if ( !is_array( $notoptions ) || !isset( $notoptions[$option] ) )

		if ( false !== get_option( $option ) )

			return false;

	$serialized_value = maybe_serialize( $value );

	$autoload = ( 'no' === $autoload ) ? 'no' : 'yes';

	do_action( 'add_option', $option, $value );

	$result = $wpdb->query( $wpdb->prepare( "INSERT INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, %s) ON DUPLICATE KEY UPDATE `option_name` = VALUES(`option_name`), `option_value` = VALUES(`option_value`), `autoload` = VALUES(`autoload`)", $option, $serialized_value, $autoload ) );

	if ( ! $result )

		return false;

	if ( ! defined( 'WP_INSTALLING' ) ) {

		if ( 'yes' == $autoload ) {

			$alloptions = wp_load_alloptions();

			$alloptions[ $option ] = $serialized_value;

			wp_cache_set( 'alloptions', $alloptions, 'options' );

		} else {

			wp_cache_set( $option, $serialized_value, 'options' );

		}

	}

	// This option exists now

	$notoptions = wp_cache_get( 'notoptions', 'options' ); // yes, again... we need it to be fresh

	if ( is_array( $notoptions ) && isset( $notoptions[$option] ) ) {

		unset( $notoptions[$option] );

		wp_cache_set( 'notoptions', $notoptions, 'options' );

	}

	do_action( "add_option_{$option}", $option, $value );

	do_action( 'added_option', $option, $value );

	return true;

}

/**

 * Removes option by name. Prevents removal of protected WordPress options.

 *

 * @package WordPress

 * @subpackage Option

 * @since 1.2.0

 *

 * @uses do_action() Calls 'delete_option' hook before option is deleted.

 * @uses do_action() Calls 'deleted_option' and 'delete_option_$option' hooks on success.

 *

 * @param string $option Name of option to remove. Expected to not be SQL-escaped.

 * @return bool True, if option is successfully deleted. False on failure.

 */

function delete_option( $option ) {

	global $wpdb;

	$option = trim( $option );

	if ( empty( $option ) )

		return false;

	wp_protect_special_option( $option );

	// Get the ID, if no ID then return

	$row = $wpdb->get_row( $wpdb->prepare( "SELECT autoload FROM $wpdb->options WHERE option_name = %s", $option ) );

	if ( is_null( $row ) )

		return false;

	do_action( 'delete_option', $option );

	$result = $wpdb->delete( $wpdb->options, array( 'option_name' => $option ) );

	if ( ! defined( 'WP_INSTALLING' ) ) {

		if ( 'yes' == $row->autoload ) {

			$alloptions = wp_load_alloptions();

			if ( is_array( $alloptions ) && isset( $alloptions[$option] ) ) {

				unset( $alloptions[$option] );

				wp_cache_set( 'alloptions', $alloptions, 'options' );

			}

		} else {

			wp_cache_delete( $option, 'options' );

		}

	}

	if ( $result ) {

		do_action( "delete_option_$option", $option );

		do_action( 'deleted_option', $option );

		return true;

	}

	return false;

}

/**

 * Delete a transient.

 *

 * @since 2.8.0

 * @package WordPress

 * @subpackage Transient

 *

 * @uses do_action() Calls 'delete_transient_$transient' hook before transient is deleted.

 * @uses do_action() Calls 'deleted_transient' hook on success.

 *

 * @param string $transient Transient name. Expected to not be SQL-escaped.

 * @return bool true if successful, false otherwise

 */

function delete_transient( $transient ) {

	do_action( 'delete_transient_' . $transient, $transient );

	if ( wp_using_ext_object_cache() ) {

		$result = wp_cache_delete( $transient, 'transient' );

	} else {

		$option_timeout = '_transient_timeout_' . $transient;

		$option = '_transient_' . $transient;

		$result = delete_option( $option );

		if ( $result )

			delete_option( $option_timeout );

	}

	if ( $result )

		do_action( 'deleted_transient', $transient );

	return $result;

}

/**

 * Get the value of a transient.

 *

 * If the transient does not exist or does not have a value, then the return value

 * will be false.