wp-parsely / src / RemoteAPI / interface-remote-api.php

interface-remote-api.php in Parse.ly 3.8.1, at src/RemoteAPI/interface-remote-api.php

36 lines 764 B

Raw Download Zip

1	<?php
2	/**
3	* Remote API: Interface
4	*
5	* @package Parsely
6	* @since 3.2.0
7	*/
8
9	declare(strict_types=1);
10
11	namespace Parsely\RemoteAPI;
12
13	use WP_Error;
14
15	/**
16	* Remote API Interface.
17	*/
18	interface Remote_API_Interface {
19	/**
20	* Returns the items provided by this interface.
21	*
22	* @param array<string, mixed> $query The query arguments to send to the remote API.
23	* @param bool $associative (optional) When TRUE, returned objects will be converted into associative arrays.
24	*
25	* @return WP_Error\|array<string, mixed>\|false
26	*/
27	public function get_items( $query, $associative = false );
28
29	/**
30	* Checks if the current user is allowed to make the API call.
31	*
32	* @return bool
33	*/
34	public function is_user_allowed_to_make_api_call(): bool;
35	}
36