add_site_option() – Function | Developer.WordPress.org

Adds a new option for the current network.

Description

Existing options will not be updated. Note that prior to 3.3 this wasn’t the case.

Parameters

$optionstringrequired: Name of the option to add. Expected to not be SQL-escaped.
$valuemixedrequired: Option value, can be anything. Expected to not be SQL-escaped.

Return

bool True if the option was added, false otherwise.

More Information

This function essentially the same as add_option() but works network wide when using WP Multisite.

The only major difference is that on multisite site-wide options will not autoload and on a single site the option will autoload. Unlike when using add_option() on a single site, the feature cannot be overridden.

Source

function add_site_option( $option, $value ) {
	return add_network_option( null, $option, $value );
}

View all references View on Trac View on GitHub

Uses	Description
add_network_option()`wp-includes/option.php`	Adds a new network option.

Used by	Description
set_site_transient()`wp-includes/option.php`	Sets/updates the value of a site transient.
wpmu_validate_user_signup()`wp-includes/ms-functions.php`	Sanitizes and validates data required for a user sign-up.
wpmu_validate_blog_signup()`wp-includes/ms-functions.php`	Processes new site registrations.

Changelog

Version	Description
4.4.0	Modified into wrapper for add_network_option()
2.8.0	Introduced.

User Contributed Notes

MakeWebBetter 5 years ago

Install the option defaults

   
 	if ( 1 == $wpmu ) {
         if ( ! get_site_option( 'wporg_lead_options' ) ) {
             add_site_option( 'wporg_lead_options', $wporg_lead_options_defaults, '', 'yes' );
         }
	} else {
         if ( ! get_option( 'wporg_lead_options' ) ) {
             add_option( 'wporg_lead_options', $wporg_lead_options_defaults, '', 'yes' );
         }
	}

Codex 9 years ago

Examples

Default usage:

add_site_option( 'my_option', 'my_value' );

Behavior if the option already exists:

echo get_site_option( 'i_exist_already' );

// Output: 'some_value'


if ( add_site_option( 'i_exist_already', 'new_value' ) ) {
   echo get_site_option( 'i_exist_already' );
} else {
   echo __( 'Already exists', 'textdomain' );
}

Skip to note 6 content

PaulC53 10 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: -1You must log in to vote on the helpfulness of this note

Parameter $value is listed as optional. It is not optional; it is required.

Log in to add feedback

add_site_option( string $option, mixed $value ): bool

In this article