update_option


update_option ( $option, $value, $autoload = null )

Parameters:
  • (string) $option Option name. Expected to not be SQL-escaped.
  • (mixed) $value Option value. Must be serializable if non-scalar. Expected to not be SQL-escaped.
  • (string|bool) $autoload Optional. Whether to load the option when WordPress starts up. For existing options, `$autoload` can only be updated using `update_option()` if `$value` is also changed. Accepts 'yes'|true to enable or 'no'|false to disable. For non-existent options, the default value is 'yes'. Default null.
Returns:
  • (bool) False if value was not updated and true if value was updated.
Defined at:
Change Log:
  • 4: .

Description

Update the value of an option that was already added.

You do not need to serialize values. If the value needs to be serialized, then it will be serialized before it is inserted into the database. Remember, resources can not be serialized or added as an option.

If the option does not exist, then the option will be added with the option value, with an $autoload value of 'yes'.

This function is designed to work with or without a logged-in user. In terms of security, plugin developers should check the current user's capabilities before updating any options.

Related Functions

update_user_option, update_blog_option, update_site_option, delete_option, update_network_option

Top Google Results

User discussions

wpseek mobile