apply_filters( “default_site_option_{$option}”, mixed $default_value, string $option, int $network_id )

Filters the value of a specific default network option.

Description

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

Parameters

$default_valuemixed
The value to return if the site option does not exist in the database.
$optionstring
Option name.
$network_idint
ID of the network.

Source

return apply_filters( "default_site_option_{$option}", $default_value, $option, $network_id );

Changelog

VersionDescription
4.7.0The $network_id parameter was added.
4.4.0The $option parameter was added.
3.4.0Introduced.

User Contributed Notes

  1. Skip to note 2 content

    Using this filter will prevent you from creating or updating an option. This is likely a bug on WordPress.
    If you want to be able to save your option but still want to use the default for when it doesn’t exist yet, then you must remove the filter before updating the option.

    // remove the filter to prevent failure to add new option.
    remove_filter( 'default_site_option_my_network_option', 'setup_default_value', 10 );
    update_site_option( 'my_network_option', 'My Option Value' );

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