pre_option │ filter-hook │ WP 6.1.0

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.

Usage

add_filter( 'pre_option', 'wp_kama_pre_option_filter', 10, 3 );

/**
 * Function for `pre_option` filter-hook.
 * 
 * @param mixed  $pre_option    The value to return instead of the option value. This differs from `$default_value`, which is used as the fallback value in the event the option doesn't exist elsewhere in get_option().
 * @param string $option        Name of the option.
 * @param mixed  $default_value The fallback value to return if the option does not exist.
 *
 * @return mixed
 */
function wp_kama_pre_option_filter( $pre_option, $option, $default_value ){

	// filter...
	return $pre_option;
}

$pre_option(mixed)

The value to return instead of the option value. This differs from $default_value, 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)

$option(string)

Name of the option.

$default_value(mixed)

The fallback value to return if the option does not exist.
Default: false

Changelog

Where the hook is called

$pre = apply_filters( 'pre_option', $pre, $option, $default_value );

Where the hook is used in WordPress