hametuha/rest-pattern

Rest API Patten class for easy create rest-api based WordPress

1.1.1 2022-12-05 06:30 UTC

Requires

• php: >=5.6
• hametuha/singleton-pattern: ^1.2

Requires (Dev)

• phpunit/phpunit: >=5.7
• yoast/phpunit-polyfills: ^1.0

GPL-3.0-or-later

• Hametuha

README

Rest API Pattern class for easy create rest-api based WordPress.

Installation

composer require haemtuha/rest-pattern

Then include autoload.php in your themes or plugins.

Implementation

This library is abstarct class for REST API. Inherit this class like below:

<?php
namespace Vendor\Library\RestApi;

use Hametuha\RestPattern\RestApiBase;

class UsersApi extends RestApiBase {

	protected $namespace = 'vendor';

	protectd $route = 'user/(?P<user_id>\d+)';

	protected function get_args( $request ) {
		return [
			'user_id' => [
				'required' => true,
				'validate_callback' => function( $var ) {
					return $var && get_userdata( $var );
				}
			],
		];
	}
	
	protected function handle_get( $request ) {
		return [
			'success' => true,
			'user' => get_userdata( $request->get_param( 'user_id' ) ),
		];
	}

}

handle_*** method will handel your request. They should return JSON convertible object(array, object), WP_REST_Restponse, or WP_Error. Alternatively, you can throw Exception in request handler and then will be automatically converted to WP_Error.

License

GPL 3.0 or later.