WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp_set_option_autoload()

wp_set_option_autoload( string $option, string|bool $autoload ): bool

In this article

Back to top

Sets the autoload value for an option in the database.

Description

This is a wrapper for wp_set_option_autoload_values(), which can be used to set the autoload value for multiple options at once.

See also

Parameters

$optionstringrequired
Name of the option. Expected to not be SQL-escaped.
$autoloadstring|boolrequired
Autoload value to control whether to load the option when WordPress starts up.
Accepts 'yes'|true to enable or 'no'|false to disable.

Return

bool True if the autoload value was modified, false otherwise.

Source

function wp_set_option_autoload( $option, $autoload ) {
	$result = wp_set_option_autoload_values( array( $option => $autoload ) );
	if ( isset( $result[ $option ] ) ) {
		return $result[ $option ];
	}
	return false;
}

View all references View on Trac View on GitHub

UsesDescription
wp_set_option_autoload_values()wp-includes/option.php

Sets the autoload values for multiple options in the database.

Changelog

VersionDescription
6.4.0Introduced.

User Contributed Notes

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