nolte/wp-endpoint

wp-endpoint

3.0.2 2021-12-16 05:09 UTC

Requires

• php: >=7.4 || >=8.0

Requires (Dev)

• squizlabs/php_codesniffer: 3.*
• wp-coding-standards/wpcs: 2.*

MIT

• Nolte
• Crisoforo Gaspar Hernandez

README

Class that makes the process to create a new WordPress endpoint more easily.

By default the endpoint are under the leen namespace with the version number 1 this data can be overwritten using any of the filters specified below.

The class provides a set of defined methods and mechanism to register a new endpoint, wich makes the process of define a new endpoint pretty straightforward.

Getting Started

The easiest way to install this package is by using composer from your terminal:

composer require nolte/wp-endpoint

Or by adding the following lines on your composer.json file

"require": {
  "nolte/wp-endpoint": "dev-master"
}

This will download the files from the packagist site and set you up with the latest version located on master branch of the repository.

After that you can include the autoload.php file in order to be able to autoload the class during the object creation.

include '/vendor/autoload.php';

Usage

After you added the dependency on your module you need to create a new class that defines your endpoint for example:

<?php
use Nolte\AbstractEndpoint;

class customEndpoint extends AbstractEndpoint {

	protected $endpoint = '/customEndpoint';

	public function endpoint_callback( \WP_REST_Request $request ) {
		$data = [
		    'data' => 'Hi',
		    'count' => 10,
            'id' => $request->get_param( 'id' )
		];
		return $this->filter_data( $data );
	}

	public function endpoint_args() {
		return [
			'id' => [
				'required' => true,
				'sanitize_callback' => function ( $id ) {
					return absint( $id );
				},
			],
		];
	}
}

On this class you have:

• init or any other name you want to expose is a public static method that always have the same signature in order to execute the code that runs the new endpoint.
• endpoint_callback , By default you have one method that allow you to define the response of the GET request to the endpoint, GET is the default HTTP Verb.
• endpoint_args, Same as endpoint_callback, is the callback by default that allow you to define if the endpoint allow parameters and how are going to be used.
• endpoint_options, if you want to specify a new set of HTTP verbs andor rewrite the default endpoint options, you only need to return an array with the parameters that are required for the endpoint.

For instance to define a new slug parameter with a different HTTP verb and reuse the default get params. You only need to define as follows

	protected function endpoint_options() {
		return [
		    [
			'methods' => \WP_REST_Server::DELETABLE,
			'callback' => [ $this, 'custom_callback_now' ],
			],
			parent::endpoint_options,
		];
	}

parent::endpoint_options is going to return the default options defined on Endpoint class if you don't want to redeclare the options for a GET request.

Collections

There is also an abstract class available for collections.

<?php namespace Nolte\Endpoints;

use Nolte\AbstractCollectionEndpoint;

class MyCollection extends AbstractCollectionEndpoint {

	protected $endpoint = '/my-collection';

	protected function loop() {
		$data = [];

		$this->query = new \WP_Query( $this->args );
		while ( $this->query->have_posts() ) {
			$this->query->the_post();
			$data[] = $this->query->post;
		}

		wp_reset_postdata();

		return [
			'data' => $data,
			'pagination' => $this->get_pagination(
				$this->query->found_posts,
				$this->query->max_num_pages
			)
		];
	}
}

Filters

• nolte_endpoints_api_namespace, This allow you to overwrite the default namespace used on the API definition.
• nolte_endpoints_api_version, This filter allow you to change the version number of the API.
• nolte_endpoints_data_${api}, where ${api} is the name of your endpoint for instance in the case above: nolte_endpoints_data_customEndpoint.
• nolte_endpoints_collection_item, to do custom formatting for collection items.