update_blog_option( int $id, string $option, mixed $value, mixed $deprecated = null )

Update an option for a particular blog.

Contents

Description Description

Parameters Parameters

$id

(int) (Required) The blog id.

$option

(string) (Required) The option key.

$value

(mixed) (Required) The option value.

$deprecated

(mixed) (Optional) Not used.

Default value: null

Top ↑

Return Return

(bool) True on success, false on failure.

Top ↑

Source Source

File: wp-includes/ms-blogs.php 

function update_blog_option( $id, $option, $value, $deprecated = null ) {
	$id = (int) $id;

	if ( null !== $deprecated ) {
		_deprecated_argument( __FUNCTION__, '3.1.0' );
	}

	if ( get_current_blog_id() == $id ) {
		return update_option( $option, $value );
	}

	switch_to_blog( $id );
	$return = update_option( $option, $value );
	restore_current_blog();

	return $return;
}

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
MU (3.0.0) Introduced.

Top ↑

Top ↑

Uses Uses

Uses
Uses Description
wp-includes/load.php: get_current_blog_id()

Retrieve the current site ID.
wp-includes/functions.php: _deprecated_argument()

Mark a function argument as deprecated and inform when it has been used.
wp-includes/option.php: update_option()

Update the value of an option that was already added.
wp-includes/ms-blogs.php: switch_to_blog()

Switch the current blog.
wp-includes/ms-blogs.php: restore_current_blog()

Restore the current blog, after calling switch_to_blog().

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by Xedin Unknown —

    The return documentation states:

    (bool) True on success, false on failure.

    However, this is not true. This function uses update_option() under the hood, and returns its result verbatim. It’s not in the reference, but the Codex doc of update_option() states:

    (boolean)
    True if option value has changed, false if not or if update failed.

    update_option() will return false if the value has not changed, such as if the new value is the same as the old, and therefore so will update_blog_option(). Thus, just because it returns false does not mean there was an error.

    Also, see this helpful comment.

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