add_option

Advertisement

Summery Summery

Adds a new option.

Syntax Syntax

add_option( string $option, mixed $value = '', string $deprecated = '', string|bool $autoload = 'yes' )

Description Description

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 cannot be serialized or added as an option.

You can create options without values and then update the values later. Existing options will not be updated and checks are performed to ensure that you aren’t adding a protected WordPress option. Care should be taken to not name options the same as the ones which are protected.

Parameters Parameters

$option

(string) (Required) Name of option to add. Expected to not be SQL-escaped.

$value

(mixed) (Optional) Option value. Must be serializable if non-scalar. Expected to not be SQL-escaped.

Default value: ''

$deprecated

(string) (Optional) Description. Not used anymore.

Default value: ''

$autoload

(string|bool) (Optional) Whether to load the option when WordPress starts up. Default is enabled. Accepts 'no' to disable for legacy reasons.

Default value: 'yes'

Return Return

(bool) False if option was not added and true if option was added.

Source Source

File: wp-includes/option.php


			

Advertisement

Changelog Changelog

Changelog
Version Description
1.0.0 Introduced.

Advertisement

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.