unregister_setting( string $option_group, string $option_name, callable $deprecated = '' )

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$option_groupstring

The settings group name used during registration.

$option_namestring

The name of the option to unregister.

$deprecatedcallableoptional

Deprecated.Default: ''

Performance profile

How much work a call to unregister_setting() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

21–101

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 101.

Plugin surface

1 hook

Third-party callbacks on 'unregister_setting' run inside this call, and their cost is not bounded by anything here.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksdo_action()called directly

Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 44 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost unregister_setting() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while unregister_setting() runs, in this order:

1. 1
   do_action( unregister_setting )actionline 3185 (+77 into the body)

   Fires immediately before the setting is unregistered and after its filters have been removed.

Uses · 4

• _deprecated_argument()Marks a function argument as deprecated and inform when it has been used.
• __()Retrieves the translation of $text.
• remove_filter()Removes a callback function from a filter hook.
• do_action()Calls the callback functions that have been added to an action hook.

Used by · 1

• remove_option_update_handler()Unregister a setting

Source code

View on Trac ↗View on GitHub ↗

3108function unregister_setting( $option_group, $option_name, $deprecated = '' ) {3109	global $new_allowed_options, $wp_registered_settings;3110 3111	/*3112	 * In 5.5.0, the `$new_whitelist_options` global variable was renamed to `$new_allowed_options`.3113	 * Please consider writing more inclusive code.3114	 */3115	$GLOBALS['new_whitelist_options'] = &$new_allowed_options;3116 3117	if ( 'misc' === $option_group ) {3118		_deprecated_argument(3119			__FUNCTION__,3120			'3.0.0',3121			sprintf(3122				/* translators: %s: misc */3123				__( 'The "%s" options group has been removed. Use another settings group.' ),3124				'misc'3125			)3126		);3127		$option_group = 'general';3128	}3129 3130	if ( 'privacy' === $option_group ) {3131		_deprecated_argument(3132			__FUNCTION__,3133			'3.5.0',3134			sprintf(3135				/* translators: %s: privacy */3136				__( 'The "%s" options group has been removed. Use another settings group.' ),3137				'privacy'3138			)3139		);3140		$option_group = 'reading';3141	}3142 3143	$pos = false;3144	if ( isset( $new_allowed_options[ $option_group ] ) ) {3145		$pos = array_search( $option_name, (array) $new_allowed_options[ $option_group ], true );3146	}3147 3148	if ( false !== $pos ) {3149		unset( $new_allowed_options[ $option_group ][ $pos ] );3150	}3151 3152	if ( '' !== $deprecated ) {3153		_deprecated_argument(3154			__FUNCTION__,3155			'4.7.0',3156			sprintf(3157				/* translators: 1: $sanitize_callback, 2: register_setting() */3158				__( '%1$s is deprecated. The callback from %2$s is used instead.' ),3159				'<code>$sanitize_callback</code>',3160				'<code>register_setting()</code>'3161			)3162		);3163		remove_filter( "sanitize_option_{$option_name}", $deprecated );3164	}3165 3166	if ( isset( $wp_registered_settings[ $option_name ] ) ) {3167		// Remove the sanitize callback if one was set during registration.3168		if ( ! empty( $wp_registered_settings[ $option_name ]['sanitize_callback'] ) ) {3169			remove_filter( "sanitize_option_{$option_name}", $wp_registered_settings[ $option_name ]['sanitize_callback'] );3170		}3171 3172		// Remove the default filter if a default was provided during registration.3173		if ( array_key_exists( 'default', $wp_registered_settings[ $option_name ] ) ) {3174			remove_filter( "default_option_{$option_name}", 'filter_default_option', 10 );3175		}3176 3177		/**3178		 * Fires immediately before the setting is unregistered and after its filters have been removed.3179		 *3180		 * @since 5.5.03181		 *3182		 * @param string $option_group Setting group.3183		 * @param string $option_name  Setting name.3184		 */3185		do_action( 'unregister_setting', $option_group, $option_name );3186 3187		unset( $wp_registered_settings[ $option_name ] );

Changelog

Introduced in 2.7.0. Unchanged from 6.7.7 through 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.