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

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


Description Description

The dynamic portion of the hook name, $option, refers to the option name.

Returning a truthy value from the filter will effectively short-circuit retrieval and return the passed value instead.


Top ↑

Parameters Parameters

$pre_option

(mixed) 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).

$option

(string) Option name.

$default

(mixed) The fallback value to return if the option does not exist. Default false.


Top ↑

Source Source

File: wp-includes/option.php

View on Trac



Top ↑

Changelog Changelog

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

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.