Function Reference/update site option

This page redirects to an external site: https://developer.wordpress.org/reference/functions/update_site_option/

1 Description
2 Usage
3 Parameters
4 Return Values
5 Examples
6 Notes
7 Change Log
8 Source File
9 Related

Description

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

Usage

<code style="color: #000000"><span style="color: #0000BB"><?php update_site_option</span><span style="color: #007700">( </span><span style="color: #0000BB">$option</span><span style="color: #007700">, </span><span style="color: #0000BB">$value </span><span style="color: #007700">); </span><span style="color: #0000BB">?></span></code>

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.

See also index of Function Reference and index of Template Tags.

Codex