unregister_setting
Unregister a setting.
Description
Parameters (3)
- 0. $option_group (string)
- The settings group name used during registration.
- 1. $option_name (string)
- The name of the option to unregister.
- 2. $deprecated — Optional. (string) =>
''
- The deprecated.
Usage
if ( !function_exists( 'unregister_setting' ) ) { require_once ABSPATH . WPINC . '/option.php'; } // The settings group name used during registration. $option_group = ''; // The name of the option to unregister. $option_name = ''; // The deprecated. $deprecated = ''; // NOTICE! Understand what this does before running. $result = unregister_setting($option_group, $option_name, $deprecated);
Defined (1)
The function is defined in the following location(s).
- /wp-includes/option.php
- function unregister_setting( $option_group, $option_name, $deprecated = '' ) {
- global $new_whitelist_options, $wp_registered_settings;
- if ( 'misc' == $option_group ) {
- _deprecated_argument( __FUNCTION__, '3.0.0', sprintf( __( '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( __( 'The "%s" options group has been removed. Use another settings group.' ), 'privacy' ) );
- $option_group = 'reading';
- }
- $pos = array_search( $option_name, (array) $new_whitelist_options[ $option_group ] );
- if ( $pos !== false ) {
- unset( $new_whitelist_options[ $option_group ][ $pos ] );
- }
- if ( '' !== $deprecated ) {
- _deprecated_argument( __FUNCTION__, '4.7.0', __( '$sanitize_callback is deprecated. The callback from register_setting() is used instead.' ) );
- 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'] );
- }
- unset( $wp_registered_settings[ $option_name ] );
- }
- }