Introduzione alla creazione del primo widget WordPress

Per i non-programmatori che creano un sito WordPress, i widget sono fantastici. Ti consentono di aggiungere menu, elenchi, feed, testo e molto altro ancora alle aree dei widget che non devono essere limitate alla barra laterale. Molti temi ora dispongono di aree widget nel piè di pagina, e le grandi strutture tema hanno spesso aree widget in più posizioni come l'intestazione e prima e dopo il contenuto.

In questa serie di cinque parti ti illustrerò i passaggi necessari per creare il tuo primo widget. La serie coprirà:

  • Introduzione ai widget e all'API dei widget
  • Codifica e registrazione del tuo widget
  • Costruire il tuo widget
  • Costruire il modulo per il tuo widget
  • Visualizzazione del widget nell'area del widget corretta

In questa parte presenterò i widget e l'API Widget.

Creazione di widget

Per creare un widget estendi il WP_Widget classe, che include un numero di funzioni:

  • una funzione per elaborare il widget
  • una funzione per visualizzare un modulo per il widget nella schermata del pannello dei widget
  • una funzione che consente agli utenti di aggiornare le impostazioni del widget
  • una funzione per generare il widget in qualsiasi area del widget a cui è stato aggiunto.

Oltre a questo, usi il register_widget () funzione per registrare il widget che hai creato.

Puoi mettere praticamente tutto ciò che vuoi all'interno di un widget: il testo statico, l'output da una query del database, un feed da un altro sito e altro ancora. Tuttavia, è importante ricordare che gli utenti si aspettano che i widget si adattino a un'area definita nella pagina, quindi l'output del widget non dovrebbe essere troppo grande.

WordPress viene fornito con una serie di widget incorporati, quindi prima di iniziare a programmare da soli, controlla che non sia già presente nel core di WordPress.

In questa serie creerò un widget da un plug-in che ho sviluppato per un tutorial precedente, sulla creazione di una barra laterale sensibile al contesto. In quel tutorial ho sviluppato una funzione che gli utenti con una certa conoscenza del codice potevano inserire nel loro tema o allegare a un hook, ma sarebbe più facile per gli utenti se potessero aggiungere la navigazione tramite un widget.

L'API Widget

L'API Widget include le funzioni necessarie per creare il tuo widget. Diamo un'occhiata a ciascuno di essi.

Innanzitutto, ci sono quattro funzioni widget:

  • is_active_widget (): un tag condizionale che controlla se un singolo widget è attivo. Non confonderlo con is_active_sidebar (), che controlla se i widget sono stati aggiunti a un'area specifica del widget.
  • the_widget (): un tag modello che visualizza un widget all'esterno delle aree del widget.
  • register_widget (): la funzione per registrare un widget, che userò più avanti in questa serie.
  • unregister_widget (): annulla la registrazione di un widget, il che significa che non è più disponibile per gli utenti tramite la schermata Widget.

Ci sono anche cinque funzioni interne:

  • wp_register_widget_control (): crea i controlli sulla schermata Widget in modo che gli utenti possano modificare le impostazioni del widget.
  • wp_unregister_widget_control (): registra il controllo del widget che è stato registrato tramite wp_register_widget_control ().
  • wp_convert_widget_settings (): converte le impostazioni di un widget da singola istanza a multi-widget.
  • wp_get_widget_defaults (): core function, non deve essere usato da sviluppatori di plugin o di temi
  • wp_widget_description (): crea una descrizione del widget che verrà visualizzata nella schermata Widget.

Per accedere a queste funzioni interne, farai uso di WP_Widget classe. Questa è una classe di costruzione, che puoi estendere per creare widget aggiuntivi.

Sommario

 Spero che questo tutorial introduttivo abbia stuzzicato la tua voglia di creare i tuoi widget. Nel prossimo tutorial ti mostrerò come codificare il tuo widget e registrarlo.