apply_filters( "pre_option_{$option}", mixed $pre_option, string $option, mixed $default_value )

Filters the value of an existing option before it is retrieved.


Description

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.


Parameters

$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().<br> Default false (to skip past the short-circuit).

$option

Option name.

$default_value

The fallback value to return if the option does not exist.<br> Default false.


Source

File: wp-includes/option.php

View on GitHub



Changelog

Changelog
Version Description
4.9.0 The $default_value parameter was added.
4.4.0 The $option parameter was added.
1.5.0 Introduced.