Unlimited Plugins, WordPress themes, videos & courses! Unlimited asset downloads! From $16.50/m
Advertisement
  1. Code
  2. WordPress
Code

Programmare ad Oggetti con WordPress : Documentiamo il Plugin II

by
Difficulty:BeginnerLength:LongLanguages:
This post is part of a series called Object-Oriented Programming in WordPress.
Object-Oriented Programming in WordPress: Document the Plugin I
Object-Oriented Programming in WordPress: Inheritance I

Italian (Italiano) translation by Piergiorgio Sansone (you can also view the original English article)

A questo punto della serie, siamo pronti ad andare avanti con l'arricchimento del nostro plugin documentando i nostri file, classi, funzioni, variabili e altro ancora.

Anche se questo è l'ultimo passo che dobbiamo compiere per completare il plugin, non è l'ultimo post della serie, continueremo a guardare alcune argomenti avanzati sulla programmazione object-oriented.

Ma prima di fare questo, portiamo il nostro plugin alla versione 1.0 mettendo in pratica tutto ciò che abbiamo imparato con articoli precedenti.

Naturalmente, come con tutti i precedenti articoli, vi consiglio di rivedere tutto ciò che abbiamo trattato finora così da rimanere al passo non solo con il lavoro che abbiamo fatto nell'ultimo articolo, ma anche per come siamo arrivati in realtà ai punti finali che stiamo discutendo in questo articolo.

  1. L'introduzione
  2. Le Classi
  3. I Types
  4. Le Strutture di Controllo : Istruzioni Condizionali
  5. La Strutture di Controllo : I Cicli
  6. Funzioni ed Attributi
  7. L'Ambito di applicazione (scopo)
  8. Costruire il Plugin I
  9. Costruire il Plugin II
  10. Documentare il Plugin I

Con tutti quelli coperti e recensiti, cominciamo con documentare ciascuno dei nostri file.

Documentiamo il Plugin

Esistono un gran numero di modi per documentare questo plugin.

  • Abbiamo potuto documentare prima tutte le intestazioni di file poi siamo potuti tornare indietro e documentare le classi, siamo potuti tornare indietro e documentare le variabili, e poi abbiamo potuto documentare le funzioni.
  • Abbiamo potuto documentare ogni file singolarmente ed avere una breve discussione su tutto ciò che era in essi incluso.

Ovviamente, l'opzione produrrà più documentazione per ogni sezione, ma dovrebbe rendere l'articolo molto meno noioso e molto più facile comprendere il flusso di controllo per l'intero plugin.

A tal fine, lavoriamo sul plugin, file per file, introducendo di documentazione per ogni pezzo di codice che abbiamo e poi discuteremo tutti i punti di interesse seguendo il codice.

Infine, faremo in modo di riferirci alla versione finale del Pluin al termine dell'articolo. Detto questo, iniziamo.

Il singolo Post Meta Manager

Ricordi che il file principale per iniziare a scrivere un plugin è single-post-meta-manager.php posizionato nella cartella di root nella disrectory del plugin.

Qui abbiamo un esempio di com'è una versione del file completamente documentata. Leggete ogni commento facendo attenzione non solo al formato da seguire, ma al contenuto espresso.

Nel codice precedente, notate che abbiamo definito un'intestazione di file secondo le convenzioni che abbiamo delineato nel precedente articolo. Abbiamo inoltre mantenuto i tag di intestazione del plugin richiesto, nell'ordine secondo WordPress corretto per leggerli.

Notate che , in questo caso, li abbiamo inclusi sotto il tag @wordpress-plugin Non è obbligatorio ma aiuta a separare i commenti dell'intestazione del file dai commenti richiesti del plugin.

Infine, notate che abbiamo alzato la versione di questo plugin fino a 1.0, e abbiamo anche dato questo plugin il valore di @package di SPMM anche se il singolo Post Meta Manager è corto. Che useremo durante il plugin.

La directory includes

Succesivamente, focalizziamoci su tutti i file che sono contenuti nella directory includes.

Poiché questi file sono necessari prima di tutto nella directory admin, sarebbe sensato guardare individualmente in ciascuno di questi file e poi tornare alla nostra discussione con i restanti file nella directory admin.

Il singolo Post Meta Manager

Chiaramente, ci sono un sacco di nuovi commenti che sono stati introdotti in questo particolare file; Tuttavia, dovrebbe essere molto facile interpretazione per quanto riguarda che cosa stanno facendo ogni proprietà della classe, il costruttore e le funzioni interne.

La cosa fondamentale da notare - a parte come le informazioni sono coordinate attraverso il plugin - è come noi abbiamo aderito agli standard definiti nel precedente articolo.

Si noti, tuttavia, che ci siamo presi la libertà se non si utilizza determinati tag e/o caratteristiche della documentazione quando essi non sono rilevanti. Questo è qualcosa che continueremo fare in tutto il resto dell'articolo.

Il singolo Post Meta Manager Loader

Notate che questa classe è più o meno un elemento essenziale del plugin nel quale coordina tutte le azioni ed i filtri utilizzati attraverso il plugin. Questo plugin consente di centralizzare tutte le registrazioni e coordinamento degli hooks che sono utilizzati in tutto il plugin.

Infine , quando viene chiamato il run , tutti gli hooks vengono registrati con WordPress cosi come i plugin , richiamerà tutte le azioni e filtri registrati.

L'admin Directory

A questo punto , siamo pronti per volgere la nostra attenzione verso i file che sono posizionati nella directory admin del plugin

Anche se il file è costituito da un paio di file PHP, si compone anche di un file CSS. Per lo scopo di questo articolo, non ci accingiamo a documentare il file CSS; Tuttavia, il WordPress Codex definisce la documentazione per questo.

Per ora, però, continuiamo a documentare le classi e i file presenti nella directory admin.

Singolo Post Meta Manager Admin

La classe del singolo Post Meta Manager Admin ha un'unica responsabilità: definire la funzionalità per rendere la casella di meta e i suoi stili per il dashboard.

Notate che la classe di cui sopra ha pochissimi dettagli funzionali. Principalmente, la classe mantiene un riferimento alla versione del plugin, il foglio di stile utilizzato per definire lo stile della casella di meta e la funzione per rendere effettivamente la casella meta necessaria.

Ricordiamo che tutto questo è configurato all'interno del file del plugin e del Loader. Questo aiuta disaccoppiare la logica che esiste all'interno il plugin in modo che ogni classe può concentrarsi sul suo scopo primario.

Naturalmente, il pezzo finale del plugin si basa sul file parziale che contiene il markup necessario per visualizzare la finestra di meta.

Singolo Post Meta Manager parziale

Questo dovrebbe essere relativamente di facile interpretazione; Tuttavia, per essere completa, si noti che questo file richiede l'ID del post corrente (tramite l'utilizzo della funzione di get_the_ID()), legge i meta dati del post, quindi scorre e costruisce una tabella che visualizza le chiavi e i valori.

Finalizzare il Plugin

A questo punto, abbiamo completato l'implementazione del nostro plugin. Sono da mettere in pratica le tecniche di programmazione ad oggetti , per documentare il codice.

Si può trovare la versione finale del plugin su GitHub; Tuttavia, continueremo la nostra discussione sulla programmazione orientata agli oggetti con qualche altro post in modo che possiamo esplorare alcuni argomenti più avanzati come l'ereditarietà, l'astrazione e altri argomenti.

Nel frattempo, se avete domande o commenti circa il plugin, non esitate a lasciarli nei commenti!

Advertisement
Advertisement
Advertisement
Advertisement
Looking for something to help kick start your next project?
Envato Market has a range of items for sale to help get you started.