Toolbox van de Smart WordPress Developer GitHub Plugin Updater

Wilt u uw plug-in niet hosten in de WordPress.org Plugin Directory? Je kunt natuurlijk besluiten dat niet te doen, het is tenslotte een vrije gemeenschap. Maar u moet het ergens hosten, zodat de plug-in kan worden gevonden en u moet ook uw gebruikers voorzien van updates voor uw plug-in. 

De meeste mensen die besluiten hun plug-ins niet te hosten op WordPress.org hebben de neiging om GitHub te gebruiken, maar WordPress weet niet hoe GitHub-gehoste plug-ins moeten worden bijgewerkt - het heeft hulp nodig. En vandaag helpen we je WordPress te helpen bij het bijwerken van je plug-ins, je raadt het al, een helperklasse.

In dit deel van de "Toolbox van de Smart WordPress Developer" -reeks gaan we door WordPress GitHub Plugin Updater, een hulpmiddel om het updateproces voor WordPress-plug-ins te beheren die worden gehost op GitHub.

Waarom GitHub gebruiken in plaats van WordPress.org?

Zoals elk ander modulair inhoudbeheersysteem heeft WordPress zijn eigen pluginrepository. En ik zou het niet verkeerd hebben als ik zei dat de WordPress.org Plugin Directory de community standaard is geworden voor het hosten van gratis en open source WordPress plug-ins.

Maar zoals ik in het begin al zei, dit is een gratis community. WordPress vereist niet dat we elke plug-in en elk thema dat we maken in de WordPress.org-directory voor plug-ins hosten. Mensen kunnen ervoor kiezen om er afstand van te nemen, en dat is volkomen natuurlijk.

De eerste plaats waar mensen hun WordPress-plug-ins hosten nadat de WordPress.org-directory Plugin GitHub is. GitHub maakt gebruik van het geweldige revisiecontrolesysteem Git en is een van de beste plaatsen om je open source software met de rest van de wereld te delen. En de laatste paar jaar hebben steeds meer WordPress-ontwikkelaars hun nieuwe plug-ins via GitHub gepubliceerd.

Voordelen en nadelen van het overschakelen van de WordPress.org-plugindirectory naar GitHub

Ik denk dat er een balans is tussen de voor- en nadelen van het hosten van WordPress-plug-ins op GitHub in plaats van de Plugin-directory van WordPress.org. Ik ga degenen in kaart brengen die bij me opkomen, maar ik zou ook graag je inbreng daarover hebben, dus aarzel niet om een ​​opmerking te schieten in het gedeelte Opmerkingen nadat je dit hebt gelezen.

Wanneer u uw plug-ins host op WordPress.org:

• U moet SVN gebruiken.
• Uw plug-in moet worden goedgekeurd door een WordPress.org-revisor voordat u deze kunt uploaden. (Dit is zowel een voordeel als een nadeel voor mij, omdat het hebben van een tweede set van ogen op de code goed is voor het opsporen van beveiligingsfouten.)
• U kunt GPL (versie 2 of hoger) alleen gebruiken als licentie.
• Uw updates voor plug-ins worden snel aan uw gebruikers gemeld.
• Noodplug-in updates (om veiligheidsredenen) worden automatisch naar de gebruikers gepusht.
• Mensen kunnen uw plug-in rechtstreeks uit hun beheerderspanelen vinden, wat een enorm pluspunt is.
• U kunt de ondersteuningsforums van WordPress.org gebruiken.

En wanneer u besluit over te schakelen naar GitHub:

• Je kunt Git gebruiken.
• Je zult oneindig veel meer vrijheid hebben.
• U kunt andere soorten licenties gebruiken (zoals MIT of CC, hoewel CC niet wordt aanbevolen voor software).
• U kunt een wiki maken, commits accepteren en met uw gebruikers over problemen praten.
• Je hebt geen beoordelingen voor je plug-ins, wat slecht is voor feedback.
• Je zult deze tutorial moeten voltooien om plugin-updates gemakkelijker te kunnen bieden.

Er is ook een leuk debat over op WordPress Tavern die - ik denk - je ook moet lezen.

Integratie van de WordPress GitHub Plugin Updater in uw plug-in

Klaar om updatemeldingen voor uw gebruikers te geven?

Eerst en vooral moet je de WordPress GitHub Plugin Updater downloaden van zijn GitHub-repository. Je hebt alleen de updater.php bestand, dus maak je geen zorgen over de anderen.

Daarna moet je de updater.php bestand ergens in uw plugin-map en neem het op in uw plug-in. Bijvoorbeeld, als u de updater.php bestand in een map met de naam github-plugin-updater en je wilt het opnemen in je hoofd plugin-bestand, dan moet je de volgende regel toevoegen aan dat bestand:

U moet ook het WP_GitHub_Updater klasse met de juiste argumenten om je plug-in te verbinden met je GitHub repo:

 plugin_basename (__FILE__), 'proper_folder_name' => 'plugin-naam', '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 / gebruikersnaam / repository-naam / zipball / master ',' sslverify '=> true,' vereist '=>' 3.0 ',' tested '=>' 3.3 ',' readme '=>' README.md ',' access_token '=> "); nieuwe WP_GitHub_Updater ($ config);?>

• naaktslak: De plug van uw plug-in.
• proper_folder_name: De naam van de map van uw plug-in.
• api_url: De API-URL van uw GitHub-repo.
• raw_url: De onbewerkte URL van uw GitHub repo.
• github_url: De URL van uw GitHub repo.
• zip_url: De postcode van je GitHub-repo.
• sslverify: Of SSL moet worden geverifieerd of niet.
• vereist: De minimale WordPress-versie die uw plug-in vereist.
• getest: De maximale WordPress-versie waarmee u uw plug-in hebt getest.
• Leesmij (verouderd): het README-bestand om de plugin-versie te controleren.
• toegangstoken: Uw GitHub-toegangstoken, als u een privé-repo gebruikt.

Om uw gebruikers op de hoogte te stellen, hoeft u alleen de versie van de plug-in in de headers van uw hoofdbestand te wijzigen. (Het lijkt erop dat deze tool werd gebruikt om het README-bestand te controleren op een regel met ~ Huidige versie: X.X ~ maar vanaf versie 1.6 zoekt het eerst naar het belangrijkste plugin-bestand.)

En dat is het! Door deze stappen te volgen, worden updatemeldingen voor uw plug-in ingeschakeld.

Inpakken voor vandaag

Als u uw WordPress-plug-in op GitHub wilt hosten en updatemeldingen wilt geven aan uw gebruikers, is de WordPress GitHub Plugin Updater een van de essentiële hulpmiddelen die u zou moeten gebruiken.

Wat vindt u van deze tool of host u WordPress-plug-ins op GitHub in het algemeen? Deel uw mening met ons door te reageren in het gedeelte Opmerkingen hieronder. En als je het artikel leuk vond, vergeet dan niet om het met je vrienden te delen!