Casella degli strumenti dello sviluppatore Smart WordPress GitHub Plugin Updater

Non vuoi ospitare il tuo plugin nella directory dei plugin di WordPress.org? Certo, puoi decidere di non farlo, dopotutto è una comunità libera. Ma devi ospitarlo da qualche parte in modo che il plugin possa essere trovato, e dovresti anche fornire agli utenti aggiornamenti al tuo plugin. 

La maggior parte delle persone che decidono di non ospitare i propri plugin su WordPress.org tendono a utilizzare GitHub, ma WordPress non sa come aggiornare i plugin ospitati da GitHub: ha bisogno di aiuto. E oggi, ti aiuteremo ad aiutare WordPress ad aggiornare i tuoi plugin con, hai indovinato, una classe di aiuto.

In questa parte della serie "Toolbox della serie Smart WordPress", analizzeremo WordPress GitHub Plugin Updater, uno strumento per gestire il processo di aggiornamento dei plugin WordPress ospitati su GitHub.

Perché usare GitHub invece di WordPress.org?

Come ogni altro sistema di gestione dei contenuti modulari, WordPress ha il proprio repository di plugin. E non mi sbaglio se dicessi che la Directory dei Plugin di WordPress.org è diventata lo standard della community per l'hosting di plugin WordPress gratuiti e open source.

Ma come ho detto all'inizio, questa è una comunità libera. WordPress non ci richiede di ospitare tutti i plugin e il tema che creiamo nella directory dei plugin di WordPress.org. Le persone possono scegliere di allontanarsi da esso, e questo è perfettamente naturale.

Il primo posto in cui le persone ospitano i loro plugin WordPress dopo che la directory dei plugin di WordPress.org è GitHub. Utilizzando l'incredibile sistema di controllo di revisione chiamato Git, GitHub è uno dei posti migliori per condividere il tuo software open source con il resto del mondo. E negli ultimi due anni, sempre più sviluppatori di WordPress hanno pubblicato i loro nuovi plugin su GitHub.

Vantaggi e svantaggi del passaggio dalla directory dei plugin di WordPress.org a GitHub

Penso che ci sia un equilibrio tra i vantaggi e gli svantaggi dell'hosting dei plugin WordPress su GitHub invece della directory dei plugin di WordPress.org. Ho intenzione di esporre quelli che mi vengono in mente, ma mi piacerebbe anche il vostro contributo su questo, quindi non esitate a sparare un commento nella sezione Commenti dopo aver letto questo.

Quando ospiti i tuoi plugin su WordPress.org:

• Devi usare SVN.
• Il tuo plugin deve essere approvato da un revisore di WordPress.org prima di poterlo caricare. (Questo è sia un vantaggio che uno svantaggio per me, poiché avere un secondo set di occhi sul codice è utile per individuare i difetti di sicurezza.)
• Puoi utilizzare GPL (versione 2 o successiva) solo come licenza.
• Gli aggiornamenti del tuo plugin verranno notificati rapidamente ai tuoi utenti.
• Gli aggiornamenti dei plug-in di emergenza (per motivi di sicurezza) verranno inviati automaticamente agli utenti.
• Le persone possono trovare il tuo plugin direttamente dai loro pannelli di amministrazione, il che è un vantaggio enorme.
• Puoi usare i forum di supporto di WordPress.org.

E quando decidi di passare a GitHub:

• Sarai in grado di usare Git.
• Avrai infinitamente più libertà.
• È possibile utilizzare altri tipi di licenze (come MIT o CC, anche se CC non è raccomandato per il software).
• Puoi creare un wiki, accettare commit e parlare di problemi con i tuoi utenti.
• Non avrai voti per i tuoi plugin, il che è negativo per il feedback.
• Dovrai completare questo tutorial per fornire più facilmente gli aggiornamenti dei plugin.

C'è anche un bel dibattito su WordPress Tavern che, penso, dovresti anche leggere.

Integrazione del plugin Plugin GitHub WordPress nel tuo plugin

Pronto a fornire notifiche di aggiornamento per i tuoi utenti?

Innanzitutto e ovviamente, è necessario scaricare l'aggiornamento del plugin GitHub WordPress dal proprio repository GitHub. Avrai solo bisogno del updater.php file, quindi non preoccuparti per gli altri.

Dopo ciò, è necessario inserire il updater.php file da qualche parte nella cartella del plugin e includilo nel tuo plugin. Ad esempio, se metti il updater.php file in una cartella denominata github-plugin-updater e vuoi includerlo nel tuo file plugin principale, devi aggiungere la seguente riga a quel file:

È inoltre necessario inizializzare il WP_GitHub_Updater class con gli argomenti corretti per connettere il tuo plugin al tuo repository GitHub:

 plugin_basename (__FILE__), 'proper_folder_name' => 'plugin-name', 'api_url' => 'https://api.github.com/repos/username/repository-name', 'raw_url' => 'https: / /raw.github.com/username/repository-name/master ',' github_url '=>' https://github.com/username/repository-name ',' zip_url '=>' https://github.com / nomeutente / nome-repository / zipball / master ',' sslverify '=> true,' requires '=>' 3.0 ',' tested "=> '3.3', 'readme' => 'README.md', 'access_token '=> "); nuovo WP_GitHub_Updater ($ config);?>

• lumaca: Il tuo plug-in slug.
• proper_folder_name: Il nome della cartella del tuo plug-in.
• api_url: L'URL dell'API del repository GitHub.
• raw_url: L'URL raw del tuo repository GitHub.
• github_url: L'URL del repository GitHub.
• zip_url: L'URL ZIP del repository GitHub.
• sslverify: Se verificare SSL o meno.
• richiede: La versione minima di WordPress richiesta dal plug-in.
• testato: La versione massima di WordPress con cui hai testato il tuo plugin.
• readme (deprecato): il file README per controllare la versione del plugin da.
• token di accesso: Il tuo token di accesso a GitHub, se stai utilizzando un repository privato.

Per informare i tuoi utenti, tutto quello che devi fare è cambiare la versione del plugin nelle intestazioni del tuo file principale. (Sembra che questo strumento utilizzato per controllare il file README per una riga contenente ~ Versione corrente: X.X ~ ma dalla versione 1.6, cerca prima il file del plugin principale).

E questo è tutto! Seguendo questi passaggi abiliterà le notifiche di aggiornamento per il tuo plugin.

Conclusione per oggi

Se vuoi ospitare il tuo plug-in WordPress su GitHub e vuoi fornire notifiche di aggiornamento per i tuoi utenti, il GitHub Plugin Updater di WordPress è uno degli strumenti essenziali che dovresti utilizzare.

Cosa ne pensi di questo strumento o di hosting di plugin WordPress su GitHub in generale? Condividi i tuoi pensieri con noi commentando nella sezione commenti qui sotto. E se ti è piaciuto l'articolo, non dimenticare di condividerlo con i tuoi amici!