WordPress.org

Ready to get started?Download WordPress

Codex

Attention Interested in functions, hooks, classes, or methods? Check out the new WordPress Code Reference!

Function Reference/add blog option

Description

Add a new option for a given blog id.

Usage

<?php add_blog_option$id$option$value ?>

Parameters

$id
(integer) (required) A blog ID. Can be null to refer to the current blog.
Default: current blog ID
$option
(string) (required) Name of option key to add. Expected to not be SQL-escaped.
Default: None
$value
(mixed) (optional) Option value, can be anything. Expected to not be SQL-escaped.
Default: None

Return Value

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

Examples

Notes

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.

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.

Change Log

Since: 3.0.0

Source File

add_blog_option() is located in wp-includes/ms-blogs.php