Tribe__Events__REST__V1__Endpoints__Archive_Venue::READ_args()
Returns the content of the args array that should be used to register the endpoint with the register_rest_route function.
Return
(array)
Source
File: src/Tribe/REST/V1/Endpoints/Archive_Venue.php
public function READ_args() {
return array(
'page' => array(
'required' => false,
'validate_callback' => array( $this->validator, 'is_positive_int' ),
'default' => 1,
'description' => __( 'The archive page to return', 'the-events-calendar' ),
'type' => 'integer',
),
'per_page' => array(
'required' => false,
'validate_callback' => array( $this->validator, 'is_positive_int' ),
'sanitize_callback' => array( $this, 'sanitize_per_page' ),
'default' => $this->get_default_posts_per_page(),
'description' => __( 'The number of venues to return on each page', 'the-events-calendar' ),
'type' => 'integer',
),
'search' => array(
'required' => false,
'validate_callback' => array( $this->validator, 'is_string' ),
'description' => __( 'Venues should contain the specified string in the title, description or custom fields', 'the-events-calendar' ),
'type' => 'string',
),
'event' => array(
'required' => false,
'validate_callback' => array( $this->validator, 'is_event_id' ),
'description' => __( 'Venues should be related to this event', 'the-events-calendar' ),
'type' => 'integer',
),
'has_events' => array(
'required' => false,
'description' => __( 'Venues should have events associated to them', 'the-events-calendar' ),
'swagger_type' => 'boolean',
),
'only_with_upcoming' => array(
'required' => false,
'description' => __( 'Venues should have upcoming events associated to them', 'the-events-calendar' ),
'swagger_type' => 'boolean',
'default' => false,
),
'status' => array(
'required' => false,
'validate_callback' => array( $this, 'filter_post_status_list' ),
'swagger_type' => 'string',
'format' => 'string',
'description' => __( 'The organizer post status', 'the-events-calendar' ),
),
);
}
Changelog
| Version | Description |
|---|---|
| 4.5 | Introduced. |