wpseek.com
A WordPress-centric search engine for devs and theme authors



add_blog_option › WordPress Function

Since
Deprecatedn/a
› add_blog_option ( $id, $option, $value )
Parameters: (3)
  • (int) $id A blog ID. Can be null to refer to the current blog.
    Required: Yes
  • (string) $option Name of option to add. Expected to not be SQL-escaped.
    Required: Yes
  • (mixed) $value Option value, can be anything. Expected to not be SQL-escaped.
    Required: Yes
Returns:
  • (bool) True if the option was added, false otherwise.
Defined at:
Codex:
Change Log:
  • MU

Adds a new option for a given blog ID.

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.


Related Functions: add_option, get_blog_option, delete_blog_option, update_blog_option, add_allowed_options

Source 

function add_blog_option( $id, $option, $value ) {
	$id = (int) $id;

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

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

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

	return $return;
}