unregister_setting

Unregister a setting.

Description

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

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

  1. if ( !function_exists( 'unregister_setting' ) ) { 
  2.     require_once ABSPATH . WPINC . '/option.php'; 
  3. } 
  4.   
  5. // The settings group name used during registration. 
  6. $option_group = ''; 
  7.   
  8. // The name of the option to unregister. 
  9. $option_name = ''; 
  10.   
  11. // The deprecated. 
  12. $deprecated = ''; 
  13.   
  14. // NOTICE! Understand what this does before running. 
  15. $result = unregister_setting($option_group, $option_name, $deprecated); 
  16.     

Defined (1)

The function is defined in the following location(s).

/wp-includes/option.php  
  1. function unregister_setting( $option_group, $option_name, $deprecated = '' ) { 
  2.     global $new_whitelist_options, $wp_registered_settings; 
  3.  
  4.     if ( 'misc' == $option_group ) { 
  5.         _deprecated_argument( __FUNCTION__, '3.0.0', sprintf( __( 'The "%s" options group has been removed. Use another settings group.' ), 'misc' ) ); 
  6.         $option_group = 'general'; 
  7.     } 
  8.  
  9.     if ( 'privacy' == $option_group ) { 
  10.         _deprecated_argument( __FUNCTION__, '3.5.0', sprintf( __( 'The "%s" options group has been removed. Use another settings group.' ), 'privacy' ) ); 
  11.         $option_group = 'reading'; 
  12.     } 
  13.  
  14.     $pos = array_search( $option_name, (array) $new_whitelist_options[ $option_group ] ); 
  15.     if ( $pos !== false ) { 
  16.         unset( $new_whitelist_options[ $option_group ][ $pos ] ); 
  17.     } 
  18.     if ( '' !== $deprecated ) { 
  19.         _deprecated_argument( __FUNCTION__, '4.7.0', __( '$sanitize_callback is deprecated. The callback from register_setting() is used instead.' ) ); 
  20.         remove_filter( "sanitize_option_{$option_name}", $deprecated ); 
  21.     } 
  22.  
  23.     if ( isset( $wp_registered_settings[ $option_name ] ) ) { 
  24.         // Remove the sanitize callback if one was set during registration. 
  25.         if ( ! empty( $wp_registered_settings[ $option_name ]['sanitize_callback'] ) ) { 
  26.             remove_filter( "sanitize_option_{$option_name}", $wp_registered_settings[ $option_name ]['sanitize_callback'] ); 
  27.         } 
  28.  
  29.         unset( $wp_registered_settings[ $option_name ] ); 
  30.     } 
  31. }