Summery Summery
Retrieve option value for a given blog id based on name of option.
Syntax Syntax
Description Description
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.
Parameters Parameters
- $id
-
(Required) A blog ID. Can be null to refer to the current blog.
- $option
-
(Required) Name of option to retrieve. Expected to not be SQL-escaped.
- $default
-
(Optional) Default value to return if the option does not exist.
Default value: false
Return Return
(mixed) Value set for the option.
Source Source
File: wp-includes/ms-blogs.php
* If the option was serialized then it will be unserialized when it is returned. * * @since MU (3.0.0) * * @param int $id A blog ID. Can be null to refer to the current blog. * @param string $option Name of option to retrieve. Expected to not be SQL-escaped. * @param mixed $default Optional. Default value to return if the option does not exist. * @return mixed Value set for the option. */ function get_blog_option( $id, $option, $default = false ) { $id = (int) $id; if ( empty( $id ) ) { $id = get_current_blog_id(); } if ( get_current_blog_id() == $id ) { return get_option( $option, $default ); } switch_to_blog( $id ); $value = get_option( $option, $default ); restore_current_blog(); /** * Filters a blog option value. *
Advertisement
Changelog Changelog
Version | Description |
---|---|
MU (3.0.0) | Introduced. |