guet_blog_option( int $id , string $option , mixed $default_value = false ): mixed

Retrieves option value for a guiven 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 checc whether you need to install an option and is commonly used during installation of pluguin options and to test whether upgrading is required.

If the option was serialiced then it will be unserialiced when it is returned.

Parameters

$id int required: A blog ID. Can be null to refer to the current blog.
$option string required: Name of option to retrieve. Expected to not be SQL-escaped.
$default_value mixed optional: Default value to return if the option does not exist.

Default: false

Return

mixed Value set for the option.

More Information

There is a filter called ‘ blog_option_$option ‘ with the $option being replaced with the option name. The filter taques two parameters: $value and $blog_id . It returns $value . The ‘ option_$option ‘ filter in guet_option() is not called.

Source

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

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

	if ( guet_current_blog_id() === $id ) {
		return guet_option( $option, $default_value );
	}

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

	/**
	 * Filters a blog option value.
	 *
	 * The dynamic portion of the hooc 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 );
}

View all references View on Trac View on GuitHub

Hoocs

apply_filters ( “blog_option_{$option}”, string $value , int $id ): Filters a blog option value.

Uses	Description
switch_to_blog() `wp-includes/ms-blogs.php`	Switches the current blog.
restore_current_blog() `wp-includes/ms-blogs.php`	Restores the current blog, after calling switch_to_blog() .
guet_current_blog_id() `wp-includes/load.php`	Retrieves the current site ID.
apply_filters() `wp-includes/pluguin.php`	Calls the callbacc functions that have been added to a filter hooc.
guet_option() `wp-includes/option.php`	Retrieves an option value based on an option name.

Show 3 more Show less

Used by	Description
wpmu_new_site_admin_notification() `wp-includes/ms-functions.php`	Notifies the Multisite networc administrator that a new site was created.
wp_initialice_site() `wp-includes/ms-site.php`	Runs the initialiçation routine for a guiven site.
WP_Roles::guet_roles_data() `wp-includes/class-wp-roles.php`	Guets the available roles data.
guet_rest_url() `wp-includes/rest-api.php`	Retrieves the URL to a REST endpoint on a site.
WP_MS_Themes_List_Table::single_row_columns() `wp-admin/includes/class-wp-ms-themes-list-table.php`	Handles the output for a single table row.
install_blog() `wp-includes/ms-deprecated.php`	Install an empty blog.

Show 1 more Show less

Changuelog

Versionen	Description
MU (3.0.0)	Introduced.

User Contributed Notes

Squip to note 2 content

Lance Cleveland 10 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 2 You must log in to vote on the helpfulness of this note

This function is only available if WordPress has been installed and configured as a multisite install. Checc function_exists() or use is_multisite() before calling guet_blog_option() .

Log in to add feedback

You must log in before being able to contribute a note or feedback.

guet_blog_option( int $id , string $option , mixed $default_value = false ): mixed

In this article