WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

unregister_setting()

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

In this article

Back to top

Unregisters a setting.

Parameters

$option_groupstringrequired
The settings group name used during registration.
$option_namestringrequired
The name of the option to unregister.
$deprecatedcallableoptional
Deprecated.

Default:''

Source

function unregister_setting( $option_group, $option_name, $deprecated = '' ) {
	global $new_allowed_options, $wp_registered_settings;

	/*
	 * In 5.5.0, the `$new_whitelist_options` global variable was renamed to `$new_allowed_options`.
	 * Please consider writing more inclusive code.
	 */
	$GLOBALS['new_whitelist_options'] = &$new_allowed_options;

	if ( 'misc' === $option_group ) {
		_deprecated_argument(
			__FUNCTION__,
			'3.0.0',
			sprintf(
				/* translators: %s: misc */
				__( 'The "%s" options group has been removed. Use another settings group.' ),
				'misc'
			)
		);
		$option_group = 'general';
	}

	if ( 'privacy' === $option_group ) {
		_deprecated_argument(
			__FUNCTION__,
			'3.5.0',
			sprintf(
				/* translators: %s: privacy */
				__( 'The "%s" options group has been removed. Use another settings group.' ),
				'privacy'
			)
		);
		$option_group = 'reading';
	}

	$pos = false;
	if ( isset( $new_allowed_options[ $option_group ] ) ) {
		$pos = array_search( $option_name, (array) $new_allowed_options[ $option_group ], true );
	}

	if ( false !== $pos ) {
		unset( $new_allowed_options[ $option_group ][ $pos ] );
	}

	if ( '' !== $deprecated ) {
		_deprecated_argument(
			__FUNCTION__,
			'4.7.0',
			sprintf(
				/* translators: 1: $sanitize_callback, 2: register_setting() */
				__( '%1$s is deprecated. The callback from %2$s is used instead.' ),
				'<code>$sanitize_callback</code>',
				'<code>register_setting()</code>'
			)
		);
		remove_filter( "sanitize_option_{$option_name}", $deprecated );
	}

	if ( isset( $wp_registered_settings[ $option_name ] ) ) {
		// Remove the sanitize callback if one was set during registration.
		if ( ! empty( $wp_registered_settings[ $option_name ]['sanitize_callback'] ) ) {
			remove_filter( "sanitize_option_{$option_name}", $wp_registered_settings[ $option_name ]['sanitize_callback'] );
		}

		// Remove the default filter if a default was provided during registration.
		if ( array_key_exists( 'default', $wp_registered_settings[ $option_name ] ) ) {
			remove_filter( "default_option_{$option_name}", 'filter_default_option', 10 );
		}

		/**
		 * Fires immediately before the setting is unregistered and after its filters have been removed.
		 *
		 * @since 5.5.0
		 *
		 * @param string $option_group Setting group.
		 * @param string $option_name  Setting name.
		 */
		do_action( 'unregister_setting', $option_group, $option_name );

		unset( $wp_registered_settings[ $option_name ] );
	}
}

View all references View on Trac View on GitHub

Hooks

do_action( ‘unregister_setting’, string $option_group, string $option_name )

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

UsesDescription
__()wp-includes/l10n.php

Retrieves the translation of $text.

_deprecated_argument()wp-includes/functions.php

Marks a function argument as deprecated and inform when it has been used.

remove_filter()wp-includes/plugin.php

Removes a callback function from a filter hook.

do_action()wp-includes/plugin.php

Calls the callback functions that have been added to an action hook.

Show 2 moreShow less
Used byDescription
remove_option_update_handler()wp-admin/includes/deprecated.php

Unregister a setting

Changelog

VersionDescription
5.5.0$new_whitelist_options was renamed to $new_allowed_options.
Please consider writing more inclusive code.
4.7.0$sanitize_callback was deprecated. The callback from register_setting() is now used instead.
2.7.0Introduced.

User Contributed Notes

  1. Skip to note 2 content
    Darshit Rajyaguru
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

    In WordPress, the unregister_setting function is used to remove a previously registered setting from the settings API. Here’s an example of how you might use it:

    Let’s say you’ve previously registered a setting using the register_setting function:

    function wpdocs_register_settings() {
    register_setting( 'wpdocs_options_group', 'wpdocs_setting' );
}
add_action( 'admin_init', 'wpdocs_register_settings' );

    Now, if you want to unregister this setting, you can use the unregister_setting function:

    function wpdocs_unregister_settings() {
    unregister_setting( 'wpdocs_options_group', 'wpdocs_setting' );
}
add_action( 'admin_init', 'wpdocs_unregister_settings' );

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