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



get_blog_option › WordPress Function

Since
Deprecatedn/a
› get_blog_option ( $id, $option, $default_value = false )
Parameters: (3)
  • (int) $id A blog ID. Can be null to refer to the current blog.
    Required: Yes
  • (string) $option Name of option to retrieve. Expected to not be SQL-escaped.
    Required: Yes
  • (mixed) $default_value Optional. Default value to return if the option does not exist.
    Required: No
    Default: false
Returns:
  • (mixed) Value set for the option.
Defined at:
Codex:
Change Log:
  • MU

Retrieves option value for a given blog id based on name of option.

If the option does not exist or does not have a value, then the return value will be false. This is useful to check whether you need to install an option and is commonly used during installation of plugin options and to test whether upgrading is required. If the option was serialized then it will be unserialized when it is returned.


Related Functions: delete_blog_option, add_blog_option, get_option, update_blog_option, get_blog_post

Source 

function get_blog_option( $id, $option, $default_value = false ) {
	$id = (int) $id;

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

	if ( get_current_blog_id() === $id ) {
		return get_option( $option, $default_value );
	}

	switch_to_blog( $id );
	$value = get_option( $option, $default_value );
	restore_current_blog();

	/**
	 * Filters a blog option value.
	 *
	 * The dynamic portion of the hook name, `$option`, refers to the blog option name.
	 *
	 * @since 3.5.0
	 *
	 * @param string  $value The option value.
	 * @param int     $id    Blog ID.
	 */
	return apply_filters( "blog_option_{$option}", $value, $id );
}