Tribe__Tickets__REST__V1__Post_Repository::get_ticket_header_image( int $ticket_id )
Returns a ticket header image information if set.
Contents
Parameters
- $ticket_id
-
(int) (Required) The ticket ID.
Return
(bool|array)
Source
File: src/Tribe/REST/V1/Post_Repository.php
public function get_ticket_header_image( $ticket_id ) {
$post = tribe_events_get_ticket_event( $ticket_id );
if ( empty( $post ) ) {
return false;
}
/** @var Tribe__Tickets__Tickets_Handler $handler */
$handler = tribe( 'tickets.handler' );
$image_id = (int) get_post_meta( $post->ID, $handler->key_image_header, true );
if ( empty( $image_id ) ) {
return false;
}
$data = $this->get_image_data( $image_id );
/**
* Filters the data that will returned for a ticket header image if set.
*
* @param array $data The ticket header image array representation.
* @param WP_Post $ticket_id The requested ticket.
* @param WP_Post $post The post this ticket is related to.
*/
return apply_filters( 'tribe_rest_event_featured_image', $data, $ticket_id, $post );
}
Changelog
| Version | Description |
|---|---|
| 4.8 | Introduced. |