Skip to content

Add autoload parameter to add_blog_option() and update_blog_option() #5994

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
remyperona wants to merge 1 commit into
base: trunk
Choose a base branch
from
Open

Add autoload parameter to add_blog_option() and update_blog_option() #5994

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 27 additions & 13 deletions src/wp-includes/ms-blogs.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -395,24 +395,31 @@ function get_blog_option( $id, $option, $default_value = false ) {
*
* @since MU (3.0.0)
*
* @param int $id A blog ID. Can be null to refer to the current blog.
* @param string $option Name of option to add. Expected to not be SQL-escaped.
* @param mixed $value Option value, can be anything. Expected to not be SQL-escaped.
* @param int $id A blog ID. Can be null to refer to the current blog.
* @param string $option Name of option to add. Expected to not be SQL-escaped.
* @param mixed $value Option value, can be anything. Expected to not be SQL-escaped.
* @param string|bool $autoload Optional. Whether to load the option when WordPress starts up.
* Accepts 'yes'|true to enable or 'no'|false to disable.
* Autoloading too many options can lead to performance problems, especially if the
* options are not frequently used. For options which are accessed across several places
* in the frontend, it is recommended to autoload them, by using 'yes'|true.
* For options which are accessed only on few specific URLs, it is recommended
* to not autoload them, by using 'no'|false. Default 'yes'.
* @return bool True if the option was added, false otherwise.
*/
function add_blog_option( $id, $option, $value ) {
function add_blog_option( $id, $option, $value, $autoload = 'yes' ) {
$id = (int) $id;

if ( empty( $id ) ) {
$id = get_current_blog_id();
}

if ( get_current_blog_id() == $id ) {
return add_option( $option, $value );
return add_option( $option, $value, '', $autoload );
}

switch_to_blog( $id );
$return = add_option( $option, $value );
$return = add_option( $option, $value, '', $autoload );
restore_current_blog();

return $return;
Expand Down Expand Up @@ -450,25 +457,32 @@ function delete_blog_option( $id, $option ) {
*
* @since MU (3.0.0)
*
* @param int $id The blog ID.
* @param string $option The option key.
* @param mixed $value The option value.
* @param mixed $deprecated Not used.
* @param int $id The blog ID.
* @param string $option The option key.
* @param mixed $value The option value.
* @param mixed $deprecated Not used.
* @param string|bool $autoload Optional. Whether to load the option when WordPress starts up.
* Accepts 'yes'|true to enable or 'no'|false to disable.
* Autoloading too many options can lead to performance problems, especially if the
* options are not frequently used. For options which are accessed across several places
* in the frontend, it is recommended to autoload them, by using 'yes'|true.
* For options which are accessed only on few specific URLs, it is recommended
* to not autoload them, by using 'no'|false. Default 'yes'.
* @return bool True if the value was updated, false otherwise.
*/
function update_blog_option( $id, $option, $value, $deprecated = null ) {
function update_blog_option( $id, $option, $value, $deprecated = null, $autoload = null ) {
$id = (int) $id;

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

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

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

return $return;
Expand Down