REST_API
REST API class.
Namespace: WebberZone\Top_Ten\Frontend
Since: 3.0.0
Source: includes/frontend/class-rest-api.php line 21
Extends: WP_REST_Controller
Methods
__construct()
Main constructor.
Since: 3.0.0
Line: 55
public function __construct( );register_routes()
Initialises the Top 10 REST API adding the necessary routes.
Since: 3.0.0
Line: 67
public function register_routes( );permissions_check()
Check if a given request has access to get items
Line: 122
public function permissions_check( WP_REST_Request $request ): \WP_Error|bool;| Type | Name | Description |
|---|---|---|
\WP_REST_Request | $request | Full data about the request. |
Returns: \WP_Error|bool
get_items()
Get popular posts.
Since: 3.0.0
Line: 144
public function get_items( $request ): mixed|\WP_REST_Response;| Type | Name | Description |
|---|---|---|
\WP_REST_Request | $request | WP Rest request. |
Returns: mixed|\WP_REST_Response — Array of post objects or post IDs.
get_item()
Get a popular post by ID. Also includes the number of views.
Since: 3.0.0
Line: 181
public function get_item( $request ): mixed|\WP_REST_Response;| Type | Name | Description |
|---|---|---|
\WP_REST_Request | $request | WP Rest request. |
Returns: mixed|\WP_REST_Response — Array of post objects or post IDs.
prepare_item()
Get a popular post by ID. Also includes the number of views.
Since: 3.0.0
Line: 214
public function prepare_item( $popular_post, $request ): array|mixed;| Type | Name | Description |
|---|---|---|
\WP_Post | $popular_post | Popular Post object. |
\WP_REST_Request | $request | WP Rest request. |
Returns: array|mixed — The formatted Popular Post object.
update_post_count()
Update post count.
Since: 3.0.0
Line: 235
public function update_post_count( $request ): mixed|\WP_REST_Response;| Type | Name | Description |
|---|---|---|
\WP_REST_Request | $request | WP Rest request. |
Returns: mixed|\WP_REST_Response — Array of post objects or post IDs.
get_counter()
Get the counter.
Since: 4.0.0
Line: 261
public function get_counter( $request ): mixed|\WP_REST_Response;| Type | Name | Description |
|---|---|---|
\WP_REST_Request | $request | WP Rest request. |
Returns: mixed|\WP_REST_Response — Array of post objects or post IDs.
get_items_params()
Get the arguments for fetching the popular posts.
Since: 3.0.0
Line: 301
public function get_items_params( ): array;Returns: array — Top 10 REST API popular posts arguments.
get_tracker_params()
Get the arguments for tracking posts.
Since: 3.0.0
Line: 330
public function get_tracker_params( ): array;Returns: array — Top 10 REST API popular posts arguments.
get_counter_params()
Get counter params.
Since: 4.0.0
Line: 364
public function get_counter_params( ): array;Returns: array — Top 10 REST API counter arguments.
check_read_permission()
Checks if a post can be read.
Correctly handles posts with the inherit status.
Since: 3.0.0
Line: 427
public function check_read_permission( $post, $request = ... ): bool;| Type | Name | Description |
|---|---|---|
\WP_Post | $post | Post object. |
\WP_REST_Request | $request | WP Rest request. |
Returns: bool — Whether the post can be read.