wpseek.com
A WordPress-centric search engine for devs and theme authors



pre_option_{$option} › WordPress Filter Hooks

Since4.9.0
Deprecatedn/a
› apply_filters( "pre_option_{$option}", false, $option, $default )
Parameters: (3)
  • (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).
    Required: Yes
  • (string) $option Option name.
    Required: Yes
  • (mixed) $default The fallback value to return if the option does not exist. Default false.
    Required: Yes
Defined at:
Codex:

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 truthy value from the filter will effectively short-circuit retrieval and return the passed value instead.



Related Functions: screen_options, update_option, get_option, add_screen_option, remove_option_update_handler, wp_timezone_string


Related Hooks: pre_site_option_option, update_option_option, option_option, site_option_option, pre_update_option_option

Source 

$pre = apply_filters( "pre_option_{$option}", false, $option, $default );