Registra un'impostazione e i suoi dati.

Parametri

$gruppo_opzioni

(stringa)(Richiesto)Nome di un gruppo di impostazioni. Deve corrispondere a un nome di chiave di opzione consentito. I nomi delle chiavi di opzione consentiti di default includono "generale", "discussione", "media", "lettura", "scrittura", "misc", "opzioni" e "privacy".

$nome_opzione

(stringa)(Richiesto)Il nome di un'opzione da sanificare e salvare.

$args

(array)(Opzionale)Dati utilizzati per descrivere l'impostazione quando viene registrata.

  • 'tipo'
    (stringa) Il tipo di dati associati a questa impostazione. I valori validi sono 'stringa', 'booleano', 'intero', 'numero', 'array' e 'oggetto'.
  • 'descrizione'
    (stringa) Una descrizione dei dati allegati a questa impostazione.
  • 'sanitize_callback'
    (richiamabile) Una funzione di callback che sanifica il valore dell'opzione.
  • 'show_in_rest'
    (bool|array) Se i dati associati a questa impostazione devono essere inclusi nell'API REST. Quando si registrano impostazioni complesse, questo argomento può essere facoltativamente un array con una chiave "schema".
  • 'default'
    (misto) Valore predefinito quando si chiama get_option().

Valore predefinito: array()

Fonte

File: wp-includes/option.php

functionregister_setting($option_group,$option_name,$args=array()){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;$defaults=array('type'=>'string','group'=>$option_group,'description'=>'','sanitize_callback'=>null,'show_in_rest'=>false,);// Back-compat: old sanitize callback is added.if(is_callable($args)){$args=array('sanitize_callback'=>$args,);}/**
	 * Filters the registration arguments when registering a setting.
	 *
	 * @since 4.7.0
	 *
	 * @param array  $args         Array of setting registration arguments.
	 * @param array  $defaults     Array of default arguments.
	 * @param string $option_group Setting group.
	 * @param string $option_name  Setting name.
	 */$args=apply_filters('register_setting_args',$args,$defaults,$option_group,$option_name);$args=wp_parse_args($args,$defaults);// Require an item schema when registering settings with an array type.if(false!==$args['show_in_rest']&&'array'===$args['type']&&(!is_array($args['show_in_rest'])||!isset($args['show_in_rest']['schema']['items']))){_doing_it_wrong(__FUNCTION__,__('When registering an "array" setting to show in the REST API, you must specify the schema for each array item in "show_in_rest.schema.items".'),'5.4.0');}if(!is_array($wp_registered_settings)){$wp_registered_settings=array();}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';}$new_allowed_options[$option_group][]=$option_name;if(!empty($args['sanitize_callback'])){add_filter("sanitize_option_{$option_name}",$args['sanitize_callback']);}if(array_key_exists('default',$args)){add_filter("default_option_{$option_name}",'filter_default_option',10,3);}/**
	 * Fires immediately before the setting is registered but after its filters are in place.
	 *
	 * @since 5.5.0
	 *
	 * @param string $option_group Setting group.
	 * @param string $option_name  Setting name.
	 * @param array  $args         Array of setting registration arguments.
	 */do_action('register_setting',$option_group,$option_name,$args);$wp_registered_settings[$option_name]=$args;}

Correlato

Utilizzi

Usi Descrizione
wp-includes/option.php: register_setting

Si attiva immediatamente prima che l'impostazione sia registrata, ma dopo che i suoi filtri sono stati attivati.

wp-includes/option.php: register_setting_args

Filtra gli argomenti di registrazione quando si registra un'impostazione.

wp-includes/l10n.php: __()

Recupera la traduzione di $testo.

wp-includes/functions.php: _fare_l_sbagliato()

Segna qualcosa come chiamato in modo errato.

wp-includes/functions.php: _deprecated_argument()

Segna un argomento di una funzione come deprecato e informa quando è stato usato.

wp-includes/functions.php: wp_parse_args()

Unisce i parametri definiti dall'utente nell'array dei valori predefiniti.

wp-includes/plugin.php: applica_filtri()

Richiama le funzioni di callback che sono state aggiunte a un gancio per i filtri.

wp-includes/plugin.php: add_filter()

Aggancia una funzione o un metodo a un'azione di filtro specifica.

wp-includes/plugin.php: do_action()

Esegue le funzioni agganciate a un gancio di azione specifico.

Usato da

Usato da Descrizione
wp-includes/option.php: register_initial_settings()

Registra le impostazioni predefinite disponibili in WordPress.

wp-admin/includes/deprecated.php: add_option_update_handler()

Registra un'impostazione e il suo callback di sanificazione

Changelog

Versione Descrizione
5.5.0 $new_whitelist_options è stato rinominato in $new_allowed_options. Si prega di considerare la possibilità di scrivere un codice più inclusivo.
4.7.0 $args può essere passato per impostare i flag sull'impostazione, in modo simile a register_meta().
2.7.0 Introdotto.