Wordpress register_sidebar()

Costruisce la definizione di una singola sidebar e ne restituisce l'ID.

Descrizione

Accetta una stringa o un array e lo analizza con una serie di argomenti predefiniti per la nuova barra laterale. WordPress genera automaticamente l'ID e il nome della barra laterale in base al numero attuale di barre laterali registrate, se questi argomenti non sono inclusi.

Quando si consente la generazione automatica dei parametri del nome e dell'ID, si tenga presente che l'incrementatore della sidebar può cambiare nel tempo a seconda degli altri plugin e temi installati.

Se il supporto del tema per i 'widget' non è ancora stato aggiunto quando questa funzione viene chiamata, verrà automaticamente abilitato attraverso l'uso di add_theme_support().

Parametri

$args

(array|stringa)(Opzionale)Array o stringa di argomenti per la barra laterale da registrare.

• 'nome'
  (stringa) Il nome o il titolo della barra laterale visualizzata nell'interfaccia dei widget. Predefinito 'Sidebar $instance'.
• 'id'
  (stringa) L'identificatore unico con cui la barra laterale sarà chiamata. Predefinito 'sidebar-$instance'.
• 'descrizione'
  (stringa) Descrizione della barra laterale, visualizzata nell'interfaccia dei widget. Stringa vuota di default.
• 'classe'
  (stringa) Classe CSS aggiuntiva da assegnare alla barra laterale nell'interfaccia dei widget.
• 'before_widget'
  (stringa) Contenuto HTML da anteporre all'output HTML di ogni widget quando viene assegnato a questa barra laterale. Riceve l'attributo ID del widget come %1$s e il nome della classe come %2$s. L'impostazione predefinita è un elemento di elenco di apertura.
• 'dopo_widget'
  (stringa) Contenuto HTML da aggiungere all'output HTML di ogni widget quando viene assegnato a questa barra laterale. L'impostazione predefinita è un elemento di chiusura dell'elenco.
• 'before_title' (prima del titolo)
  (stringa) Contenuto HTML da anteporre al titolo della barra laterale quando viene visualizzato. L'impostazione predefinita è un elemento h2 di apertura.
• 'dopo_titolo'
  (stringa) Contenuto HTML da aggiungere al titolo della barra laterale quando viene visualizzato. L'impostazione predefinita è un elemento h2 di chiusura.
• 'before_sidebar'
  (stringa) Contenuto HTML da anteporre alla barra laterale quando viene visualizzata. Riceve l'elemento $id come %1$s e $class come %2$s. Esce dopo l'azione 'dynamic_sidebar_before'. Stringa vuota predefinita.
• dopo_sidebar
  (stringa) Contenuto HTML da aggiungere alla barra laterale quando viene visualizzata. Viene emesso prima dell'azione 'dynamic_sidebar_after'. Stringa vuota di default.

Valore predefinito: array()

Ritorno

(stringa) ID della barra laterale aggiunto al globale $wp_registered_sidebars.

Fonte

File: wp-includes/widgets.php

functionregister_sidebar($args=array()){global$wp_registered_sidebars;$i=count($wp_registered_sidebars)+1;$id_is_empty=empty($args['id']);$defaults=array(/* translators: %d: Sidebar number. */'name'=>sprintf(__('Sidebar %d'),$i),'id'=>"sidebar-$i",'description'=>'','class'=>'','before_widget'=>'
','after_widget'=>"
n",'before_title'=>'
','after_title'=>"
n",'before_sidebar'=>'','after_sidebar'=>'',);/**
	 * Filters the sidebar default arguments.
	 *
	 * @since 5.3.0
	 *
	 * @see register_sidebar()
	 *
	 * @param array $defaults The default sidebar arguments.
	 */$sidebar=wp_parse_args($args,apply_filters('register_sidebar_defaults',$defaults));if($id_is_empty){_doing_it_wrong(__FUNCTION__,sprintf(/* translators: 1: The 'id' argument, 2: Sidebar name, 3: Recommended 'id' value. */__('No %1$s was set in the arguments array for the "%2$s" sidebar. Defaulting to "%3$s". Manually set the %1$s to "%3$s" to silence this notice and keep existing sidebar content.'),'id',$sidebar['name'],$sidebar['id']),'4.2.0');}$wp_registered_sidebars[$sidebar['id']]=$sidebar;add_theme_support('widgets');/**
	 * Fires once a sidebar has been registered.
	 *
	 * @since 3.0.0
	 *
	 * @param array $sidebar Parsed arguments for the registered sidebar.
	 */do_action('register_sidebar',$sidebar);return$sidebar['id'];}

Correlato

Utilizzi

Usato da

Changelog