De Envato API gebruiken met WordPress

Vandaag bespreken we hoe de Envato-API in WordPress te gebruiken en een WordPress shortcode te maken die onze Envato Marketplace-items binnen onze WordPress-site promoot. We zullen de krachtige Envato API, WordPress 'flexibiliteit en een beetje creativiteit combineren om een ​​geweldige plug-in voor onze site te bouwen..

Laten we ons doel stellen

In deze tutorial gaan we ons concentreren op:

• Enkele basiskennis over de Envato API
• Hoe API-resultaatgegevens in WordPress te gebruiken
• Bouw een WordPress Shortcode die Envato Marketplace-items promoot op onze WordPress-site.

Dus laten we naar de eerste gaan!

Stap 1: De Envato API begrijpen

Envato biedt een API waarmee ontwikkelaars informatie kunnen krijgen over Envato Marketplace-items, gebruikersinformatie, populaire projecten, enzovoort. Alle mogelijke vragen worden vermeld in de officiële documentatie. In dit artikel bespreken we alleen de openbare API.

De Envato Public API heeft de volgende structuur.

 http://marketplace.envato.com/api/edge/set.json

Het woord reeks moet worden vervangen door een optie die wordt vermeld in de kolom set van de API-documentatie. Dus als we alle informatie willen over een marktplaatsitem dat we moeten vervangen reeks met artikel: the_item_id. De uiteindelijke aanvraag-URL is:

 http://marketplace.envato.com/api/edge/item:1263846.json

U kunt proberen de bovenstaande URL in uw webbrowser in te voegen en de geretourneerde gegevens te bekijken.

We kunnen er ook meer dan één samenvoegen stel optie in in een enkel verzoek om meer gegevens te ontvangen. We willen bijvoorbeeld de artikelgegevens en de auteursinformatie. Dus de vorige URL wordt:

 http://marketplace.envato.com/api/edge/item:1263846+user:evoG.json

De Envato-API retourneert JSON, dus in de volgende alinea laten we zien hoe u deze in WordPress kunt beheren.

Stap 2: API-resultaten gebruiken in WordPress

In deze zelfstudie bespreken we niet hoe we een WordPress-plug-in kunnen maken, maar we gaan ons concentreren op enkele technieken om de API in WordPress te gebruiken:

• Stuur de API-aanvraag
• Beheer de resultaatgegevens (de JSON-reeks)

De onderstaande functie haalt de gegevens op van de Envato-server en retourneert een PHP-array die alle gewenste informatie bevat.

 / ** * @param String $ item_id - Het ID van een Envato Marketplace-artikel * @returns Array - De artikelinformatie * / functie WPTP_get_item_info ($ item_id) / * Stel de API-URL in,% s wordt vervangen door het item-ID * / $ api_url = "http://marketplace.envato.com/api/edge/item:%s.json"; / * Gegevens ophalen met behulp van de WordPress-functie wp_remote_get () * / $ response = wp_remote_get (sprintf ($ api_url, $ item_id)); / * Controleer op fouten, als er fouten zijn, retourneer dan false * / if (is_wp_error ($ response) of (wp_remote_retrieve_response_code ($ response)! = 200)) return false;  / * Transformeer de JSON-reeks in een PHP-array * / $ item_data = json_decode (wp_remote_retrieve_body ($ response), true); / * Controleer op onjuiste gegevens * / if (! Is_array ($ item_data)) return false;  / * Return item info array * / return $ item_data; 

We kunnen de bovenstaande functie verbeteren. Om stress op de Envato API-server te voorkomen, kunnen we artikelgegevens in de cache opslaan en de info na een time-out opnieuw aanvragen. WordPress biedt ons enkele functies om deze functie te implementeren. Laten we het toevoegen.

 / ** * @param String $ item_id - De ID van een Envato Marketplace-artikel * @returns Array - De artikelinformatie * / functie WPTP_get_item_info ($ item_id) / * Data-cache-time-out in seconden - Het verzendt elk uur een nieuw verzoek in plaats van van elke pagina verversen * / $ CACHE_EXPIRATION = 3600; / * Stel de tijdelijke ID in voor caching * / $ transient_id = 'WPTP_envato_item_data'; / * Verkrijg de gecachte gegevens * / $ cached_item = get_transient ($ transient_id); / * Controleer of de functie een nieuwe API-aanvraag moet verzenden * / if (! $ Cached_item || ($ cached_item-> item_id! = $ Item_id)) / * Stel de API-URL in,% s wordt vervangen door het item ID * / $ api_url = "http://marketplace.envato.com/api/edge/item:%s.json"; / * Gegevens ophalen met behulp van de WordPress-functie wp_remote_get () * / $ response = wp_remote_get (sprintf ($ api_url, $ item_id)); / * Controleer op fouten, als er fouten zijn, retourneer dan false * / if (is_wp_error ($ response) of (wp_remote_retrieve_response_code ($ response)! = 200)) return false;  / * Transformeer de JSON-reeks in een PHP-array * / $ item_data = json_decode (wp_remote_retrieve_body ($ response), true); / * Controleer op onjuiste gegevens * / if (! Is_array ($ item_data)) return false;  / * Gegevens voorbereiden voor caching * / $ data_to_cache = nieuwe stdClass (); $ data_to_cache-> item_id = $ item_id; $ data_to_cache-> item_info = $ item_data; / * Stel de transient - cache-itemgegevens * / set_transient in ($ transient_id, $ data_to_cache, $ CACHE_EXPIRATION); / * Return item info array * / return $ item_data;  / * Als het item al in de cache staat, stuur dan de cache info * terug / return $ cached_item-> item_info; 

Nu is de kernfunctie van onze WordPress-plug-in klaar. We hebben enkele WordPress-functies gebruikt die ons helpen tijd te besparen. Alle informatie over hen wordt uitgelegd in de officiële WordPress Codex.

• wp_remote_get () - Haalt een URL op met behulp van de HTTP GET-methode
• wp_remote_retrieve_response_code () - Controleert of er geen fouten in de onbewerkte reactie voorkomen
• wp_remote_retrieve_body () - Haalt de hoofdtekst van een reeds opgehaald HTTP-verzoek op.
• set_transient () - Gegevens in cache
• get_transient () - Krijgt gegevens in de cache

Stap 3: Bouw WordPress Shortcode

In de volgende stappen gaan we een nuttige WordPress-plug-in coderen waarmee we informatie over een Envato Marketplace-item kunnen weergeven. Alle onderstaande code is goed becommentarieerd, zodat u elke regel gemakkelijk kunt begrijpen. Voor meer informatie over het schrijven van een WordPress-plug-in en de WordPress Shortcode API bekijk de online documentatie in de WordPress Codex.

Laten we beginnen

Laten we de koptekstinformatie voor onze plug-in schrijven

  
Voeg de WordPress shortcode toe
 
Nu schrijven we de code om de shortcode en de functionaliteiten ervan toe te voegen.
 
 "), $ atts); extract ($ atts); / * Validation * / if (empty ($ item_id)) retourneer"
Voer een Envato Marketplace-item-ID in.
"; / * Verkrijg data van de API * / $ item = WPTP_get_item_info ($ item_id); / * Validatie - Controleer of er iets fout is gegaan * / if ($ item === false) terug"
Oeps! Er is iets misgegaan. Bekijk de item-ID en probeer het opnieuw.
"; / * Formaat $ item array * / $ item = $ item ['item']; extract ($ item); / * De HTML-invoegtoepassing voorbereiden * / $ html ="; $ html. = ' 
 
'$ Post.'
 
 
 
 beoordeling'. WPTP_get_stars ($ rating). '
  
  
 
  
 '$ Omzet.' verkoop 
  
  
  
  
  
 $'.Round ($ kosten).' enkel en alleen 
  
  
  
  
  
  
 '; return $ html; 
 
Sterwaarderingsfunctie
 
De WPTP_add_shortcode () functie hierboven heeft de WPTP_get_stars () procedure die het ratingnummer naar HTML-sterren omspant. Laten we het implementeren.
 
 Nog geen beoordeling