Adăugarea programatică a widget-urilor în bare laterale

Când am început acest răspuns, trebuia să fie doar o mică notă. Ei bine, am eșuat. Îmi pare rău! Rămâi cu mine, este un mic dar ascuns adânc...

Cum sunt stocate widget-urile în WordPress

Lista de widget-uri este stocată într-o opțiune numită 'sidebars_widgets'. Un var_export() poate afișa ceva similar cu următorul exemplu:

array (
  'wp_inactive_widgets' => 
  array (
  ),
  'top-widget' => 
  array (
  ),
  'bottom-widget' => 
  array (
  ),
  'array_version' => 3,
)

Ignoră 'wp_inactive_widgets' și 'array_version'. Nu trebuie să ne îngrijorăm de acestea.
Celelalte chei sunt identificatori pentru barele laterale înregistrate. În acest caz, barele laterale au fost înregistrate cu următorul cod:

// Înregistrăm două bare laterale.
$sidebars = array ( 'a' => 'top-widget', 'b' => 'bottom-widget' );
foreach ( $sidebars as $sidebar )
{
    register_sidebar(
        array (
            'name'          => $sidebar,
            'id'            => $sidebar,
            'before_widget' => '',
            'after_widget'  => ''
        )
    );
}

Implicit, barele laterale sunt goale după înregistrare. Bineînțeles.

Pentru fiecare clasă de widget înregistrată, se creează o opțiune separată care conține toate setările necesare. Opțiunea este prefixată cu șirul widget_. Pentru a obține setările pentru toate widget-urile RSS active, trebuie să căutăm în...

get_option( 'widget_rss' );

Posibil rezultat:

array (
  2 => 
  array (
    'title' => 'WordPress Stack Exchange',
    'url' => 'http://wordpress.stackexchange.com/feeds',
    'link' => 'http://wordpress.stackexchange.com/questions',
    'items' => 5,
    'show_summary' => 1,
    'show_author' => 0,
    'show_date' => 0,
  ),
)

Observă numărul 2. Argumentele pentru mai multe instanțe sunt stocate în această singură opțiune, sortate după numere.

Pentru a vedea ce clase de widget sunt deja cunoscute de WordPress, mergi la wp-admin/options.php și derulează până găsești ceva similar cu:

Da, date serializate. Nu, nu le poți citi aici. Nu-ți face griji, nu trebuie.

Un widget demo

Pentru a ilustra mai bine funcționarea internă, am scris un widget demo foarte simplu:

/**
 * Widget super simplu.
 */
class T5_Demo_Widget extends WP_Widget
{
    public function __construct()
    {                      // id_base        ,  nume vizibil
        parent::__construct( 't5_demo_widget', 'T5 Demo Widget' );
    }

    public function widget( $args, $instance )
    {
        echo $args['before_widget'], wpautop( $instance['text'] ), $args['after_widget'];
    }

    public function form( $instance )
    {
        $text = isset ( $instance['text'] )
            ? esc_textarea( $instance['text'] ) : '';
        printf(
            '<textarea class="widefat" rows="7" cols="20" id="%1$s" name="%2$s">%3$s</textarea>',
            $this->get_field_id( 'text' ),
            $this->get_field_name( 'text' ),
            $text
        );
    }
}

Observă constructorul: 't5_demo_widget' este $id_base, identificatorul pentru acest widget. După cum poți vedea în captura de ecran, argumentele sale sunt stocate în opțiunea widget_t5_demo_widget. Toate widget-urile tale personalizate vor fi tratate la fel. Nu trebuie să ghicești numele. Și din moment ce tu ai scris widget-urile tale (probabil), cunoști toate argumentele din parametrii $instance ai clasei tale.

Bazele temei

Mai întâi trebuie să înregistrezi câteva bare laterale și widget-ul personalizat. Acțiunea potrivită pentru aceasta este ușor de reținut: 'widgets_init'. Pune totul într-un container – o clasă sau o funcție. Pentru simplitate, voi folosi o funcție numită t5_default_widget_demo().

Tot codul următor merge în functions.php. Clasa T5_Demo_Widget ar trebui să fie deja încărcată. Am pus-o în același fișier...

add_action( 'widgets_init', 't5_default_widget_demo' );

function t5_default_widget_demo()
{
    // Înregistrăm propriul nostru widget.
    register_widget( 'T5_Demo_Widget' );

    // Înregistrăm două bare laterale.
    $sidebars = array ( 'a' => 'top-widget', 'b' => 'bottom-widget' );
    foreach ( $sidebars as $sidebar )
    {
        register_sidebar(
            array (
                'name'          => $sidebar,
                'id'            => $sidebar,
                'before_widget' => '',
                'after_widget'  => ''
            )
        );
    }

Până aici, simplu. Tema noastră este acum pregătită pentru widget-uri, widget-ul demo este cunoscut. Acum distracția.

$active_widgets = get_option( 'sidebars_widgets' );

if ( ! empty ( $active_widgets[ $sidebars['a'] ] )
    or ! empty ( $active_widgets[ $sidebars['b'] ] )
)
{   // Okay, nu mai e distractiv. Există deja conținut.
    return;
}

Nu vrei să distrugi setările utilizatorului. Dacă există deja conținut în barele laterale, codul tău nu ar trebui să le suprascrie. De aceea ne oprim în acest caz.

Okay, presupunând că barele laterale sunt goale... avem nevoie de un contor:

$counter = 1;

Widget-urile sunt numerotate. Aceste numere sunt al doilea identificator pentru WordPress.

Să obținem array-ul pentru a-l modifica:

$active_widgets = get_option( 'sidebars_widgets' );

Avem nevoie și de un contor (mai multe despre asta mai târziu):

$counter = 1;

Și iată cum folosim contorul, numele barelor laterale și argumentele widget-ului (ei bine, avem doar un argument: text).

// Adăugăm un widget 'demo' în bara laterală de sus...
$active_widgets[ $sidebars['a'] ][0] = 't5_demo_widget-' . $counter;
// ...și scriem ceva text în el:
$demo_widget_content[ $counter ] = array ( 'text' => "Funcționează!\n\nUimitor!" );

$counter++;

Observă cum este creat identificatorul widget-ului: id_base, un minus - și contorul. Conținutul widget-ului este stocat într-o altă variabilă $demo_widget_content. Aici contorul este cheia și argumentele widget-ului sunt stocate într-un array.

Incrementăm contorul cu unu când am terminat pentru a evita coliziunile.

Asta a fost ușor. Acum un widget RSS. Mai multe câmpuri, mai multă distracție!

$active_widgets[ $sidebars['a'] ][] = 'rss-' . $counter;
// Ultimele 15 întrebări de la WordPress Stack Exchange.
$rss_content[ $counter ] = array (
    'title'        => 'WordPress Stack Exchange',
    'url'          => 'http://wordpress.stackexchange.com/feeds',
    'link'         => 'http://wordpress.stackexchange.com/questions',
    'items'        => 15,
    'show_summary' => 0,
    'show_author'  => 1,
    'show_date'    => 1,
);
update_option( 'widget_rss', $rss_content );

$counter++;

Aici este ceva nou: update_option() va stoca argumentele widget-ului RSS într-o opțiune separată. WordPress le va găsi automat mai târziu.
Nu am salvat argumentele widget-ului demo pentru că adăugăm o a doua instanță în a doua noastră bară laterală acum...

// Okay, acum la a doua noastră bară laterală. Să o facem scurtă.
$active_widgets[ $sidebars['b'] ][] = 't5_demo_widget-' . $counter;
#$demo_widget_content = get_option( 'widget_t5_demo_widget', array() );
$demo_widget_content[ $counter ] = array ( 'text' => 'A doua instanță a uimitorului nostru widget demo.' );
update_option( 'widget_t5_demo_widget', $demo_widget_content );

...și salvăm toate argumentele pentru t5_demo_widget dintr-o dată. Nu este nevoie să actualizăm aceeași opțiune de două ori.

Ei bine, destule widget-uri pentru astăzi, să salvăm și sidebars_widgets:

update_option( 'sidebars_widgets', $active_widgets );

Acum WordPress va ști că există câteva widget-uri înregistrate și unde sunt stocate argumentele pentru fiecare widget. Un var_export() pe sidebars_widgets va arăta astfel:

array (
  'wp_inactive_widgets' => 
  array (
  ),
  'top-widget' => 
  array (
    0 => 't5_demo_widget-1',
    1 => 'rss-2',
  ),
  'bottom-widget' => 
  array (
    0 => 't5_demo_widget-3',
  ),
  'array_version' => 3,
)

Codul complet din nou:

add_action( 'widgets_init', 't5_default_widget_demo' );

function t5_default_widget_demo()
{
    // Înregistrăm propriul nostru widget.
    register_widget( 'T5_Demo_Widget' );

    // Înregistrăm două bare laterale.
    $sidebars = array ( 'a' => 'top-widget', 'b' => 'bottom-widget' );
    foreach ( $sidebars as $sidebar )
    {
        register_sidebar(
            array (
                'name'          => $sidebar,
                'id'            => $sidebar,
                'before_widget' => '',
                'after_widget'  => ''
            )
        );
    }

    // Okay, acum partea distractivă.

    // Nu vrem să anulăm modificările utilizatorului, așa că căutăm mai întâi modificări.
    $active_widgets = get_option( 'sidebars_widgets' );

    if ( ! empty ( $active_widgets[ $sidebars['a'] ] )
        or ! empty ( $active_widgets[ $sidebars['b'] ] )
    )
    {   // Okay, nu mai e distractiv. Există deja conținut.
        return;
    }

    // Barele laterale sunt goale, să punem ceva în ele.
    // Ce zici de un widget RSS și două instanțe ale widget-ului nostru demo?

    // Observă că widget-urile sunt numerotate. Avem nevoie de un contor:
    $counter = 1;

    // Adăugăm un widget 'demo' în bara laterală de sus...
    $active_widgets[ $sidebars['a'] ][0] = 't5_demo_widget-' . $counter;
    // ...și scriem ceva text în el:
    $demo_widget_content[ $counter ] = array ( 'text' => "Funcționează!\n\nUimitor!" );
    #update_option( 'widget_t5_demo_widget', $demo_widget_content );

    $counter++;

    // Asta a fost ușor. Acum un widget RSS. Mai multe câmpuri, mai multă distracție!
    $active_widgets[ $sidebars['a'] ][] = 'rss-' . $counter;
    // Ultimele 15 întrebări de la WordPress Stack Exchange.
    $rss_content[ $counter ] = array (
        'title'        => 'WordPress Stack Exchange',
        'url'          => 'http://wordpress.stackexchange.com/feeds',
        'link'         => 'http://wordpress.stackexchange.com/questions',
        'items'        => 15,
        'show_summary' => 0,
        'show_author'  => 1,
        'show_date'    => 1,
    );
    update_option( 'widget_rss', $rss_content );

    $counter++;

    // Okay, acum la a doua noastră bară laterală. Să o facem scurtă.
    $active_widgets[ $sidebars['b'] ][] = 't5_demo_widget-' . $counter;
    #$demo_widget_content = get_option( 'widget_t5_demo_widget', array() );
    $demo_widget_content[ $counter ] = array ( 'text' => 'A doua instanță a uimitorului nostru widget demo.' );
    update_option( 'widget_t5_demo_widget', $demo_widget_content );

    // Acum salvăm array-ul $active_widgets.
    update_option( 'sidebars_widgets', $active_widgets );
}

Dacă mergi acum la wp-admin/widgets.php, vei vedea trei widget-uri pre-setate:

Și asta este. Folosește...

dynamic_sidebar( 'top-widget' );
dynamic_sidebar( 'bottom-widget' );

...pentru a afișa widget-urile.

Există o mică problemă: Trebuie să încarci front-end-ul de două ori pentru înregistrarea inițială. Dacă cineva poate ajuta aici, voi fi foarte recunoscător.