WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp_protect_special_option()

wp_protect_special_option( string $option )

In this article

Back to top

Protects WordPress special option from being modified.

Description

Will die if $option is in protected list. Protected options are ‘alloptions’ and ‘notoptions’ options.

Parameters

$optionstringrequired
Option name.

Source

function wp_protect_special_option( $option ) {
	if ( 'alloptions' === $option || 'notoptions' === $option ) {
		wp_die(
			sprintf(
				/* translators: %s: Option name. */
				__( '%s is a protected WP option and may not be modified' ),
				esc_html( $option )
			)
		);
	}
}

View all references View on Trac View on GitHub

UsesDescription
esc_html()wp-includes/formatting.php

Escaping for HTML blocks.

wp_die()wp-includes/functions.php

Kills WordPress execution and displays HTML page with an error message.

Used byDescription
wp_set_option_autoload_values()wp-includes/option.php

Sets the autoload values for multiple options in the database.

update_network_option()wp-includes/option.php

Updates the value of a network option that was already added.

add_network_option()wp-includes/option.php

Adds a new network option.

update_option()wp-includes/option.php

Updates the value of an option that was already added.

add_option()wp-includes/option.php

Adds a new option.

delete_option()wp-includes/option.php

Removes an option by name. Prevents removal of protected WordPress options.

Show 1 moreShow less

Changelog

VersionDescription
2.2.0Introduced.

User Contributed Notes

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