Hoe Wordpress plugins werken

De plugin architectuur van Wordpress laat toe om functionaliteit toe te voegen aan je blog zonder de core Wordpress code onder handen te moeten nemen. Als je van plan bent dit te doen is een inleiding tot het schrijven van plugins voor Wordpress waarschijnlijk welgekomen.

Een definitie

Het aantal Wordpress plugins dat je kan gebruiken is langzamerhand niet meer te overzien. Elk van deze plugins zorgt ervoor dat je Wordpress blog over wat extra mogelijkheden beschikt. De plugins kan je onderbrengen in 2 categorieën: de active plugins en de passieve plugins.

Passieve plugins activeer je in je Wordpress admin, waarna je hier of daar wat code toevoegt aan je template. Een voorbeeld van een passieve plugin is Brian’s Latest Comments. Als je deze plugin activeert kan je door het toevoegen van een stukje code de meest recente reacties op je blog tevoorschijn toveren. Maar jij moet dus nog wat doen.

Actieve plugins daarentegen zijn wat zelfstandiger. Je activeert ze, configureert ze indien nodig en laat ze daarna gewoon hun werk doen. Voorbeelden van actieve plugins zijn Bad Behaviour en Delicious Daily Posting Formatter (DDPF). De Bad Behaviour plugin komt in actie wanneer een reactie wordt geplaatst, de DDPF plugin komt in actie wanneer del.icio.us besluit om jouw links op je weblog te posten.

Arrrrr!

Actieve plugins maken gebruik van de zogenoemde haken binnen Wordpress. Ze haken zich vast aan één of meerdere gebeurtenissen (of events), zoals het opslaan van een bericht of reactie en het publiceren van een bericht.

De DDPF plugin haakt zich vast aan 3 events:

• on_activation
• admin_menu
• save_post

Door zich vast te haken aan het on_activation event kan de plugin ervoor zorgen dat bepaalde dingen worden klaargemaakt voor het gebruik van de plugin. Bijvoorbeeld het opslaan van de standaardeigenschappen van de plugin in de database. Het admin_menu event laat toe om een pagina toe te voegen aan de Wordpress administratiesectie zodat gebruikers de plugin gemakkelijk kunnen configureren. Het save_post event tenslotte, zorgt ervoor dat bepaalde code wordt uitgevoerd op het moment dat een bericht wordt opgeslagen.

Het triggeren van het event

De belangrijkste code van de DDPF plugin wordt uitgevoerd bij het opslaan van een bericht.

1. Del.icio.us stuurt een XML bericht met jouw links voor vandaag naar je blog.
2. Wordpress verwerkt het XML bericht, maakt er een post van en slaat die op.
3. Wordpress laat alle plugins aan bod komen die zich vastgehaakt hebben aan het save_post event, waaronder DDPF.
4. Nadat de plugins hun werk hebben gedaan wordt de post gepubliceerd.

Binnenin

De plugin gaat zoals gezegd een stuk code uitvoeren die het net opgeslagen bericht moet formatteren naar de wensen van de gebruiker.

1. De net opgeslagen post wordt opgehaald uit de database.
2. Er wordt nagegaan of de post een del.icio.us daily posting is. Dit gebeurt aan de hand van de titel die bij del.icio.us daily posting het stramien "links for yyyy-mm-dd" volgt, waarbij yyyy een jaartal is, mm een maand en dd een dag.
3. Er zijn 2 mogelijkheden: de post komt niet van del.icio.us, dus is de rol van de plugin uitgespeeld en moet er verder niets meer gedaan worden, of de post komt wel van del.icio.us. In dit geval kunnen we verder met de volgende stap.
4. De post wordt geparset door de parser. Dit wil zeggen dat alle subelementen uit de post worden gehaald. De subelementen van een del.icio.us post zijn de bookmarks, die op hun beurt weer bestaan uit een URL, een titel, een beschrijving en één of meerdere tags. Een tag bestaat uit een URL en een titel.
5. De subelementen die de parser verzameld heeft, worden meegegeven aan de formatter die deze objecten zal gebruiken om een post samen te stellen die voldoet aan de wensen van de gebruiker. Dit gebeurt door de placeholders te vervangen door de overeenkomstige waarden uit de post.
6. De resulterende post wordt opgeslagen in de database.

Als je nu echt nog meer wilt weten over de DDPF plugin, of Wordpress plugins in het algemeen, raad ik je aan om rustig de code te bestuderen.

Dit artikel werd opgenomen in ontwikkeling, software, weblogs.