get_site_option( string $option, mixed $default_value = false, bool $deprecated = true ): mixed
- Since
- 2.8.0, 4.4.0, 4.4.0
- Source
wp-includes/option.php:1932
Retrieve an option value for the current network based on name of option.
Parameters
$optionstring- Name of the option to retrieve. Expected to not be SQL-escaped.
$default_valuemixedoptional- Value to return if the option doesn't exist. Default false.Default:
false $deprecatedbooloptional- Whether to use cache. Multisite only. Always set to true.Default:
true
Return
mixed- Value set for the option.
Uses · 1
- get_network_option()Retrieves a network's option value based on the option name.
Used by · 50
- Core_Upgrader::should_update_to_version()Determines if this WordPress Core version should update to an offered version or not.
- WP_Automatic_Updater::after_core_update()Checks whether to send an email and avoid processing future updates after attempting a core update.
- WP_Automatic_Updater::send_core_update_notification_email()Notifies an administrator of a core update.
- WP_Automatic_Updater::send_debug_email()Prepares and sends an email of a full log of background update results, useful for debugging and geekery.
- WP_Automatic_Updater::send_email()Sends an email upon the completion or failure of a background core update.
- WP_Automatic_Updater::send_plugin_theme_email()Sends an email upon the completion or failure of a plugin or theme background update.
- WP_Automatic_Updater::should_update()Tests to see if we can and should update a specific item.
- WP_Debug_Data::get_wp_active_theme()Gets the WordPress active theme section of the debug data.
- WP_Debug_Data::get_wp_parent_theme()Gets the WordPress parent theme section of the debug data.
- WP_Debug_Data::get_wp_plugins_raw_data()Gets the raw plugin data for the WordPress active and inactive sections of the debug data.
- WP_Debug_Data::get_wp_themes_inactive()Gets the WordPress inactive themes section of the debug data.
- WP_MS_Themes_List_Table::column_autoupdates()Handles the auto-updates column output.
Show all 50
- WP_MS_Themes_List_Table::prepare_items()Prepares the themes list for display.
- WP_Plugins_List_Table::prepare_items()
- WP_Plugins_List_Table::single_row()
- WP_REST_Attachments_Controller::check_upload_size()Determine if uploaded file exceeds space quota on multisite.
- WP_Recovery_Mode_Cookie_Service::recovery_mode_hash()Gets a form of `wp_hash()` specific to Recovery Mode.
- WP_Site_Health_Auto_Updates::test_if_failed_update()Checks if automatic updates have tried to run, but failed, previously.
- WP_Theme::get_allowed_on_network()Returns array of stylesheet names of themes allowed on the network.
- WP_Theme::network_disable_theme()Disables a theme for all sites on the current network.
- WP_Theme::network_enable_theme()Enables a theme for all sites on the current network.
- WP_Themes_List_Table::no_items()
- _upgrade_core_deactivate_incompatible_plugins()
- _wp_privacy_send_request_confirmation_notification()Notifies the site administrator via email when a request is confirmed.
- _wp_upload_dir()A non-filtered, non-cached version of wp_upload_dir() that doesn't check the path.
- activate_plugin()Attempts activation of plugin in a "sandbox" and redirects on success.
- check_upload_mimes()Checks an array of MIME types against a list of allowed types.
- check_upload_size()Determines whether uploaded file exceeds space quota.
- core_auto_updates_settings()Display WordPress auto-updates settings.
- deactivate_plugins()Deactivates a single plugin or multiple plugins.
- deactivated_plugins_notice()Renders an admin notice when a plugin was deactivated during an update.
- dismiss_core_update()Dismisses core update.
- get_core_updates()Gets available core updates.
- get_dashboard_blog()Get the "dashboard blog", the blog where users without a blog edit their profile data.
- get_locale()Retrieves the current locale.
- get_site_transient()Retrieves the value of a site transient.
- get_space_allowed()Returns the upload quota for the current blog.
- get_super_admins()Retrieves a list of super admins.
- get_upload_space_available()Determines if there is any upload space left in the current blog's quota.
- grant_super_admin()Grants Super Admin privileges.
- install_blog()Install an empty blog.
- is_email_address_unsafe()Checks an email address against a list of banned domains.
- is_plugin_active_for_network()Determines whether the plugin is active for the entire network.
- is_upload_space_available()Determines if there is any upload space left in the current blog's quota.
- list_plugin_updates()Display the upgrade plugins form.
- list_theme_updates()Display the upgrade themes form.
- maintenance_nag()Displays maintenance nag HTML message.
- map_meta_cap()Maps a capability to the primitive capabilities required of the given user to satisfy the capability being checked.
- ms_site_check()Checks status of current blog.
- ms_upload_constants()Defines Multisite upload constants.
Source
function get_site_option( $option, $default_value = false, $deprecated = true ) { return get_network_option( null, $option, $default_value );}History
Introduced in 2.8.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
4.4.0
Modified into wrapper for get_network_option()from the docblock
4.4.0
The
$use_cache parameter was deprecated.from the docblock2.8.0
Introduced.from the docblock
About this page
- Parsed data
- Generated from the wordpress-develop 7.0.4 tag, from
src/wp-includes/option.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.