WordPress.org

Description

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

Usage

<?php update_site_option( $option, $value ); ?>

Parameters

$option

(string) (required) Name of option. Expected to not be SQL-escaped.

Default: None

$value

(mixed) (required) Option value. Expected to not be SQL-escaped.

Default: None

Return Values

(boolean) 

False if value was not updated and true if value was updated.

Examples

Notes

• Uses: apply_filters() - Calls 'pre_update_site_option_$option' hook to allow overwriting the option value to be stored.
• Uses: do_action() - Calls 'update_site_option_$option' and 'update_site_option' hooks on success.

Change Log

• 3.4.0 - update_site_option() was moved from wp-includes/functions.php to wp-includes/option.php.
• Since: 2.8.0

Source File

update_site_option() is located in wp-includes/option.php.

Related

• Options API
• add_option()
• add_blog_option()
• add_site_option()
• delete_option()
• delete_blog_option()
• delete_site_option()
• form_option()
• get_option()
• get_blog_option()
• get_site_option()
• get_site_url()
• get_user_option()
• update_option()
• update_blog_option()
• update_site_option()
• update_user_option()
• wp_load_alloptions()