wp_protect_special_option( string $option ): void

Description

Parameters

$optionstring

Option name.

Return

void

Never returns if $option is protected, as the function dies in that case.

Uses · 3

• wp_die()Kills WordPress execution and displays HTML page with an error message.
• __()Retrieves the translation of $text.
• esc_html()Escaping for HTML blocks.

Used by · 6

• add_network_option()Adds a new network option.
• add_option()Adds a new option.
• delete_option()Removes an option by name. Prevents removal of protected WordPress options.
• update_network_option()Updates the value of a network option that was already added.
• update_option()Updates the value of an option that was already added.
• wp_set_option_autoload_values()Sets the autoload values for multiple options in the database.

Source

View on Trac ↗View on GitHub ↗

565function wp_protect_special_option( $option ) {566	if ( 'alloptions' === $option || 'notoptions' === $option ) {567		wp_die(568			sprintf(569				/* translators: %s: Option name. */570				__( '%s is a protected WP option and may not be modified' ),571				esc_html( $option )572			)573		);574	}575}

History

Introduced in 2.2.0. One change between 6.7.7 and 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 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.