User Tools

Site Tools

Trace:

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
programmieren:wordpress:rest_api_einrichten [2019/08/20 22:32] – jgehrkeprogrammieren:wordpress:rest_api_einrichten [2024/07/12 20:10] (current) – jgehrke
Line 1: Line 1:
 ====== Wordpress Rest-API Endpunkt einrichten ====== ====== Wordpress Rest-API Endpunkt einrichten ======
 +
 +**AKTUALISIERTE VERSION MIT STATIC CLASS »» ** [[programmieren:wordpress:rest_api_mit_statischer_klasse|]]
 +
  
 Mit diesem Script kann ein neuer Rest-API Endpunkt eingerichtet werden, der dann über die Website URL aufrufbar ist. In diesem Beispiel wird ein //News Endpunkt// erstellt, alles nur fiktiv, aber es zeigt wie man es macht. Mit diesem Script kann ein neuer Rest-API Endpunkt eingerichtet werden, der dann über die Website URL aufrufbar ist. In diesem Beispiel wird ein //News Endpunkt// erstellt, alles nur fiktiv, aber es zeigt wie man es macht.
Line 6: Line 9:
 <?php <?php
 /* /*
- Eigener Endpoint für News-Posts, damit eine komplett eigene + Eigener Endpoint damit eine komplett eigeneJSON Ausgabe erzeugt werden kann
- JSON Ausgabe erzeugt werden kann+
  
  Doku : https://developer.wordpress.org/rest-api/extending-the-rest-api/adding-custom-endpoints/  Doku : https://developer.wordpress.org/rest-api/extending-the-rest-api/adding-custom-endpoints/
Line 14: Line 16:
  /*  /*
   REST URL :   REST URL :
- /wp-json/mein-blog/v1/news/PAGE_NUMBER+ http://localhost:8888/wp-json/mein-namespace/v1/items/<TYPE:string>/<LEVEL:integer>
  
   */   */
 add_action( 'rest_api_init', 'register_news_endpoint' ); add_action( 'rest_api_init', 'register_news_endpoint' );
 function register_news_endpoint(){ function register_news_endpoint(){
- $namespace = 'mein-blog/v1'; + // http://localhost:8888/wp-json/mein-namespace/v1/items/<TYPE:string>/<ID:integer> 
- $route     = '/news/(?P<current_page>\d+)'; + // ohne Slash am Anfang und Ende 
- $args      = [ + $namespace = 'mein-namespace/v1'; 
- 'methods'  => 'GET', + /* type => string aus klein Großbuchsten, Zahlen & -, sowie _ */ 
- 'callback' => 'render_rest_news_endpoint', + /* ID => integer Zahl */ 
- ];+ $route     = 'items/(?P<type>[a-zA-Z0-9-_]+)/(?P<id>\d+)/'; 
 + $args      = [ 
 + 'methods'  => 'GET', 
 + 'callback' => 'render_rest_item_endpoint', 
 + 'permission_callback' => '__return_true', 
 + ];
  
- register_rest_route( $namespace, $route, $args );+ register_rest_route( $namespace, $route, $args );
 } }
  
Line 34: Line 41:
  *  *
  */  */
-function render_rest_news_endpoint( $data ) {+function render_rest_item_endpoint( $request ) {
  /*  /*
- WP codiert hier alles als JSON selbst nach. + WP codiert selbst alles im "Return" als JSON. 
- Damit das JSON nicht doppelt encoded wird + Alles was davor ausgegeben wird, taucht 1:1 so im Browser auf
- muss es einmal rückgaing gemacht werden.+
  */  */
  
- $current_page = $data['current_page'];+ $type = $request['type']; 
 + $ID = $request['id'];
  
- $thema_slug = ( isset( $_GET['thema'] ) ) ? $_GET['thema'] : false;+ $return_array = [ 
 + 'type' => $type, 
 + 'ID'      => $ID, 
 + ];
  
- // Daten immer als Array anliefern, da alles was hier raus kommt + return $return_array; /* <- wird automatisch in JSON umgewandelt */
- // noch mal json_encoded wird - da ist (array) das sicherste +
- return json_decode( get_news_json( $thema_slug, ['paged' => $current_page ] ) );+
 } }
  
 </code> </code>
 +
 +===== Alternative Schreibweise als Klasse/Objekt =====
 +
 +Es ist sinnvoll die Registrierung der REST-API Route in Wordpress in eine eigene Klasse zu packen. Man verhindert Namenskonflikte, schafft mehr Übersichtlichkeit und hat insgesamt bessere Code-Qualität.
 +
 +<code php>
 +/**
 + *
 + */
 +class CreateTrackingPoint
 +{
 +
 + function __construct()
 + {
 + add_action( 'rest_api_init', [ $this, 'register_endpoint'] );
 + }
 +
 + public function register_endpoint()
 + {
 + // /wp-json/moewe-tracking/v1/tracking_create/<USER_ID:integer>/<EVENT_TYPE:string>
 + $namespace = 'moewe-tracking/v1'; // ohne Slash am Anfang und Ende
 + $route     = 'tracking_create/(?P<user_id>\d+)/(?P<event_type>[a-zA-Z0-9-_]+)/';
 + $args      = [
 + 'methods'             => 'GET',
 + 'callback'            => [ $this, 'render_endpoint' ],
 + 'permission_callback' => '__return_true',
 + ];
 +
 + register_rest_route( $namespace, $route, $args );
 + }
 +
 + public function render_endpoint( $request ) {
 +
 + $user_id    = $request['user_id'];
 +    $event_type = $request['event_type'];
 +
 + $return_array = [
 + 'user_id'    => $user_id,
 + 'event_type' => $event_type,
 + ];
 +
 +
 +
 + return $return_array; /* <- wird automatisch in JSON umgewandelt */
 + }
 +}
 +</code>
 +
programmieren/wordpress/rest_api_einrichten.1566340326.txt.gz · Last modified: (external edit)
CC Attribution-Share Alike 4.0 International Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International

Page Tools