get_blog_option( int $id, string $option, mixed $default_value = false ): mixed
- Since
- MU (3.0.0)
- Source
wp-includes/ms-blogs.php:357
Retrieves option value for a given blog id based on name of option.
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
$idint- A blog ID. Can be null to refer to the current blog.
$optionstring- Name of option to retrieve. Expected to not be SQL-escaped.
$default_valuemixedoptional- Default value to return if the option does not exist.Default:
false
Return
mixed- Value set for the option.
Hooks fired · 1
One hook fires while get_blog_option() runs, in this order:
- apply_filters( blog_option_{$option} )filterline 382 (+25 into the body)
Filters a blog option value.
Uses · 5
- get_current_blog_id()Retrieves the current site ID.
- get_option()Retrieves an option value based on an option name.
- switch_to_blog()Switches the current blog.
- restore_current_blog()Restores the current blog, after calling switch_to_blog().
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 6
- WP_MS_Themes_List_Table::single_row_columns()Handles the output for a single table row.
- WP_Roles::get_roles_data()Gets the available roles data.
- get_rest_url()Retrieves the URL to a REST endpoint on a site.
- install_blog()Install an empty blog.
- wp_initialize_site()Runs the initialization routine for a given site.
- wpmu_new_site_admin_notification()Notifies the Multisite network administrator that a new site was created.
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 );}History
Introduced in MU (3.0.0). Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.8.8 tag, from
src/wp-includes/ms-blogs.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.