Als je, zoals velen, een WordPress website hebt, is het logisch dat je informatie uit Codex wil weergeven op je site. Daar hebben we wat voor gebouwd, namelijk de Codex Connector. Hiermee kan je gemakkelijk in posts en in je WordPress thema Codex informatie weergeven en ook formulieren met informatie opsturen naar Codex.

Voordat je begint:

Zorg dat je de API manager module aan het staan in Codex en dat de juiste modules aanstaan waarvoor je  
Zorg dat je een WordPress website hebt draaien en dat je toegang hebt tot het beheer van deze website.
Het vergt wat technische kennis om deze plug-in goed te gebruiken. Betrek indien nodig een technische contactpersoon uit je vereniging of een (web)commissie hierbij. 

Belangrijke informatie:
Codex levert deze plug-in op een As-Is basis en is niet verantwoordelijk voor het gebruik van de plug-in. De plug-in heeft een licentie waardoor de plug-in source code niet zomaar gereproduceerd of doorverkocht mag worden. Als developers verbonden aan jouw organisatie werken met Codex, moeten wij (het bedrijf achter Codex) hiervan op de hoogte gesteld worden via e-mail. Tevens moeten deze developers akkoord gaan met de voorwaarden voor tweede-partij developers.
Lees hier alles over het ontwikkelen van je eigen uitbreidingen op Codex.

Installatie

Op dit moment is handmatige installatie de enige oplossing; binnenkort wordt de plug-in mogelijk via de WordPress Plug-in marktplaats.

Handmatige installatie

Download de Connector hier: https://gitlab.com/codexology/codex-connector

Upload de inhoud van de Connector naar de wp-content/plugins/  folder. De connector’s index.phpstaat dan dus op locatie 

wp-content/plugins/codex-connector/index.php  

Als je in je wordpress admin omgeving kijkt, hoort Codex nu bij plugins te staan: klik hier op Activeren of Activate

Vervolgens kan je in de navigatiebalk een Codex Connector link vinden:

Op deze pagina kan je de Connector verbinden met je Codex. Hiervoor heb je gegevens nodig die je via de API Manager kan vinden in Codex.

Zodra dit goed is gezet, zie je onderin de status van je verbinding.
Als er iets niet klopt, zul je ook 

Via de marktplaats: Komt binnenkort.

Gebruiken

Nadat Codex gekoppeld is kan je de Connector op verschillende manieren gebruiken, elk met een eigen moeilijkheidsgraad.

In je posts: Shorttags (moeilijkheid: beginner)

Je kan informatie uit Codex weergeven in je website door middel van “Shorttags”, korte stukjes tekst die je in je pagina’s of posts plaatst. Dit doe je bijvoorbeeld als volgt bij het bewerken van een WordPress post:

Of in kopieerbare code:

Hier staat een lijst van groepen:

[codex_groups]

Hier staat de naam van de eerste groep:

[codex_group id=1]

Overwegingen:

  • Voordeel is dat je hier geen programmeerkennis voor hoeft te hebben en dat er veel verschillende shorttags bestaan.
  • Nadeel is dat je vastzit aan de manier waarop de Connector deze dingen weergeeft (vaak redelijk statisch en simpel) en je kan niet makkelijk je eigen shorttags maken.

Hieronder komt een volledige lijst van Shorttags:
komt binnenkort.

In je Thema Template: Actions (moeilijkheid: medium)

Als je je thema kan bewerken en je kan arbitraire PHP code uitvoeren, dan kan je alle functies die je als shorttag hebt ook als action uitvoeren. Dit doe je bijv. als volgt voor dezelfde shorttags als in de voorbeelden hierboven:
Alle groepen ophalen:

<?php 
$groups = do_action('codex_groups');

// @todo: render or use the groups

of voor een groep:

<?php 
$id = 1;
$group = do_action('codex_group',$id);

// @todo: render or use the group

Let op: als je Actions gebruikt en je krijgt een error bij een actie, dan krijg je dat terug als een Exception. Dit moet je dus netjes try-catchen.

In je eigen plug-in: Functions (moeilijkheid: geavanceerd)

Je kan ook de functies van Codex Connector zelf aanroepen, met als belangrijkse functie de volgende:

$response = Codex_Connector_API::api_call(
$method,
$endpoint,
$auth,
$data
);

Parameters:

  • $method : de methode die je wil gebruiken. Keuze op dit moment uit get  of post 
  • $endpoint : is de endpoint die je wil aanroepen. Een lijst van alle endpoints die je kan gebruiken kan je vinden in de API documentatie van Codex (komt nog online, is al op aanvraag beschikbaar).
  • $auth  : boolean of er authenticatie nodig is. Indien true , zal er ook een authentication handshake geprobeerd worden en wordt het token meegestuurd bij de uiteindelijke request.
  • $data : een array met data die je in het request wil meesturen (nodig bij post-methode requests

Je krijgt een response met daarin de data of een error als het niet lukt om de API call te doen. Je moet dan ook weer zelf errors afvangen.

Hulp Vragen

Vraag ons via de chat om hulp, of laat je developer contact opnemen. Lees hier meer over hoe jouw developers met Codex kunnen samenwerken en hoe ze hulp kunnen krijgen