Accentsconagua

Verktøykasse til utvikleren av Smart WordPress GitHub Plugin Updater

Kode
Share

Vil du ikke være vert for pluginet ditt i WordPress.org Plugin Directory? Selvfølgelig kan du bestemme deg for ikke-det er jo et fritt fellesskap. Men du må være vert for det et sted slik at pluginet kan bli funnet, og du bør også gi brukerne oppdateringer til pluginet ditt. 

De fleste som bestemmer seg for ikke å være vert for plugins på WordPress.org, pleier å bruke GitHub, men WordPress vet ikke hvordan man oppdaterer GitHub-hosted plugins. Det trenger hjelp. Og i dag hjelper vi deg med å hjelpe WordPress til å oppdatere pluginene dine, du gjettet det, en hjelperklasse.

I denne delen av "Toolbox of the Smart WordPress Developer" -serien skal vi gå gjennom WordPress GitHub Plugin Updater, et verktøy for å håndtere oppdateringsprosessen for WordPress-plugins hosted på GitHub.

Hvorfor bruke GitHub i stedet for WordPress.org?

Som alle andre modulære innholdssystemer har WordPress sitt eget plugin-lager. Og jeg ville ikke gå galt hvis jeg sa at WordPress.org Plugin Directory har blitt fellesskapsstandarden for hosting gratis og åpen kildekode WordPress plugins.

Men som jeg sa i begynnelsen, er dette et fritt fellesskap. WordPress krever ikke at vi vert for alle plugin og tema vi lager i WordPress.org Plugin Directory. Folk kan velge å bevege seg bort fra det, og det er helt naturlig.

Det første stedet folk er vert for deres WordPress-plugins etter at WordPress.org Plugin Directory er GitHub. Ved hjelp av det fantastiske revisjonskontrollsystemet som heter Git, er GitHub et av de beste stedene å dele åpen kildekodeprogramvare med resten av verden. Og i de siste par årene har flere og flere WordPress-utviklere publisert sine nye plugins over GitHub.

Fordeler og ulemper ved å bytte fra WordPress.org Plugin Directory til GitHub

Jeg tror at det er en balanse mellom fordelene og ulempene ved hosting WordPress-plugins på GitHub i stedet for WordPress.org Plugin Directory. Jeg kommer til å legge ut de som kommer til tankene mine, men jeg vil gjerne ha inntrykk på dette også, så ikke nøl med å skyte en kommentar i kommentarfeltet etter å ha lest dette.

Når du er vert for pluginene dine på WordPress.org:

  • Du må bruke SVN.
  • Ditt plugin må godkjennes av en WordPress.org-korrekturleser før du kan laste den opp. (Dette er både en fordel og en ulempe for meg, fordi å ha et andre sett med øyne på koden er bra for å oppdage sikkerhetsfeil.)
  • Du kan bare bruke GPL (versjon 2 eller nyere) som lisensiering.
  • Dine plugin oppdateringer vil bli varslet til brukerne dine raskt.
  • Nødoppdateringsoppdateringer (av sikkerhetshensyn) vil bli presset automatisk til brukerne.
  • Folk kan finne pluginet ditt direkte fra deres administrasjonspaneler, noe som er et stort pluss.
  • Du kan bruke støttefora for WordPress.org.

Og når du bestemmer deg for å bytte til GitHub:

  • Du vil kunne bruke Git.
  • Du vil ha uendelig mer frihet.
  • Du kan bruke andre typer lisenser (som MIT eller CC, selv om CC ikke anbefales for programvare).
  • Du kan opprette en wiki, godta forpliktelser og snakke om problemer med brukerne.
  • Du vil ikke ha noen karakterer for pluginene dine, noe som er dårlig for tilbakemelding.
  • Du må fullføre denne veiledningen for å kunne gi plugin oppdateringer lettere.

Det er også en fin debatt over på WordPress Tavern som-jeg tror-du bør også lese.

Integrering av WordPress GitHub Plugin Updater i Plugin

Klar til å gi oppdateringsvarsler for brukerne dine?

Først og åpenbart må du laste ned WordPress GitHub Plugin Updater fra sitt GitHub-depot. Du trenger bare updater.php fil, så ikke bekymre deg for de andre.

Etter det må du sette updater.php fil et sted i plugin-mappen din og legg den inn i plugin-modulen din. For eksempel, hvis du setter updater.php fil i en navngitt mappe GitHub-plugin-updater og du vil inkludere den i hovedpluginfilen din, må du legge til følgende linje i den filen:

Du må også initialisere WP_GitHub_Updater klasse med de riktige argumentene for å koble til pluginet ditt til GitHub repo:

 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 / brukernavn / repository-name / zipball / master ',' sslverify '=> sant,' krever '=>' 3.0 ',' testet '=>' 3.3 ',' readme '=>' README.md ',' access_token '=> "); ny WP_GitHub_Updater ($ config);?>
  • slug: Pluggen din er slug.
  • proper_folder_name: Navnet på plugin-mappen din.
  • api_url: GitHub-repoens API-nettadresse.
  • raw_url: GitHub-repoens røde nettadresse.
  • github_url: Din GitHub repo URL.
  • zip_url: GitHub-repoens ZIP-adresse.
  • sslverify: Enten å verifisere SSL eller ikke.
  • krever: Den minste WordPress-versjonen som pluginet ditt krever.
  • testet: Den maksimale WordPress-versjonen som du testet pluginet på.
  • readme (deprecated): README-filen for å sjekke plugin-versjonen fra.
  • access_token: GitHub-tilgangstoken din, hvis du bruker en privat repo.

For å varsle brukerne, er alt du trenger å gjøre, å endre versjonen av pluginet i hovedfilens overskrifter. (Det ser ut til at dette verktøyet ble brukt til å sjekke README-filen for en linje som inneholder ~ Nåværende versjon: X.X ~ men fra versjon 1.6 ser det ut til hoved pluginfilen først.)

Og det er det! Ved å følge disse trinnene aktiveres oppdateringsvarsler for pluginet ditt.

Wrapping Up for Today

Hvis du vil være vert for WordPress-plugin på GitHub, og vil gi oppdateringsvarsler for brukerne, er WordPress GitHub Plugin Updater et av de viktigste verktøyene du bør bruke av.

Hva synes du om dette verktøyet, eller hosting WordPress-plugins på GitHub generelt? Del dine tanker med oss ​​ved å kommentere i kommentarfeltet nedenfor. Og hvis du likte artikkelen, ikke glem å dele den med vennene dine!

Kode
×