pre_site_option_{$option}

Advertisement

Summery Summery

Filters an existing network option before it is retrieved.

Syntax Syntax

apply_filters( "pre_site_option_{$option}", mixed $pre_option, string $option, int $network_id, mixed $default )

Description Description

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

Passing a truthy value to the filter will effectively short-circuit retrieval, returning the passed value instead.

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

$option

(string) Option name.

$network_id

(int) ID of the network.

$default

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

Source Source

File: wp-includes/option.php

Advertisement

Changelog Changelog

Changelog
Version Description
4.9.0 The $default parameter was added.
4.7.0 The $network_id parameter was added.
4.4.0 The $option parameter was added.
3.0.0
2.9.0 Introduced.

Advertisement

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.