pre_option_(option)
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 value other than false from the filter will short-circuit retrieval and return that value instead.
Usage
add_filter( 'pre_option_(option)', 'wp_kama_pre_option_filter', 10, 3 ); /** * Function for `pre_option_(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 Option name. * @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)
- Option name.
- $default_value(mixed)
- The fallback value to return if the option does not exist.
Default: false
Changelog
Since 1.5.0 | Introduced. |
Since 4.4.0 | The $option parameter was added. |
Since 4.9.0 | The $default_value parameter was added. |
Where the hook is called
wp-includes/option.php 132
$pre = apply_filters( "pre_option_{$option}", false, $option, $default_value );
Where the hook is used in WordPress
wp-admin/includes/bookmark.php 338
add_filter( 'pre_option_link_manager_enabled', '__return_true', 100 );
wp-admin/includes/bookmark.php 340
remove_filter( 'pre_option_link_manager_enabled', '__return_true', 100 );
wp-admin/options-discussion.php 341
add_filter( 'pre_option_show_avatars', '__return_true', 100 );
wp-admin/options-discussion.php 351
remove_filter( 'pre_option_show_avatars', '__return_true', 100 );
wp-includes/class-wp-customize-manager.php 729
remove_filter( 'pre_option_template_root', array( $this, 'get_template_root' ) );
wp-includes/class-wp-customize-manager.php 728
remove_filter( 'pre_option_stylesheet_root', array( $this, 'get_stylesheet_root' ) );
wp-includes/class-wp-customize-manager.php 725
remove_filter( 'pre_option_template', array( $this, 'get_template' ) );
wp-includes/class-wp-customize-manager.php 724
remove_filter( 'pre_option_stylesheet', array( $this, 'get_stylesheet' ) );
wp-includes/class-wp-customize-manager.php 721
remove_filter( 'pre_option_current_theme', array( $this, 'current_theme' ) );
wp-includes/class-wp-customize-manager.php 691
add_filter( 'pre_option_template_root', array( $this, 'get_template_root' ) );
wp-includes/class-wp-customize-manager.php 690
add_filter( 'pre_option_stylesheet_root', array( $this, 'get_stylesheet_root' ) );
wp-includes/class-wp-customize-manager.php 687
add_filter( 'pre_option_template', array( $this, 'get_template' ) );
wp-includes/class-wp-customize-manager.php 686
add_filter( 'pre_option_stylesheet', array( $this, 'get_stylesheet' ) );
wp-includes/class-wp-customize-manager.php 683
add_filter( 'pre_option_current_theme', array( $this, 'current_theme' ) );
wp-includes/class-wp-customize-setting.php 379
add_filter( "pre_option_{$id_base}", array( $this, '_preview_filter' ) );
wp-includes/class-wp-customize-widgets.php 2136
add_filter( "pre_option_{$option_name}", array( $this, 'capture_filter_pre_get_option' ) );
wp-includes/class-wp-customize-widgets.php 2178
remove_filter( "pre_option_{$option_name}", array( $this, 'capture_filter_pre_get_option' ) );
wp-includes/default-filters.php 469
add_filter( 'pre_option_gmt_offset', 'wp_timezone_override_offset' );
wp-includes/default-filters.php 475
add_filter( 'pre_option_embed_autourls', '__return_true' );