tribe_tickets_buy_button( bool $echo = true )
Echo remaining ticket count and purchase/rsvp buttons for a post.
Contents
Parameters
- $echo
-
(bool) (Optional) Whether or not we should print.
Default value: true
Return
(string)
Source
File: src/template-tags/tickets.php
function tribe_tickets_buy_button( $echo = true ) {
$event_id = get_the_ID();
// check if there are any tickets on sale
if ( ! tribe_events_has_tickets_on_sale( $event_id ) ) {
return null;
}
// get an array for ticket and rsvp counts
$types = Tribe__Tickets__Tickets::get_ticket_counts( $event_id );
// if no rsvp or tickets return
if ( ! $types ) {
return null;
}
$html = array();
$parts = array();
// If we have tickets or RSVP, but everything is Sold Out then display the Sold Out message
foreach ( $types as $type => $data ) {
if ( ! $data['count'] ) {
continue;
}
if ( ! $data['available'] ) {
$parts[ $type . '-stock' ] = '<span class="tribe-out-of-stock">' . esc_html_x( 'Sold out', 'list view stock sold out', 'event-tickets' ) . '</span>';
// Only re-apply if we don't have a stock yet
if ( empty( $html['stock'] ) ) {
$html['stock'] = $parts[ $type . '-stock' ];
}
} else {
$stock = $data['stock'];
if ( $data['unlimited'] || ! $data['stock'] ) {
// if unlimited tickets, tickets with no stock and rsvp, or no tickets and rsvp unlimited - hide the remaining count
$stock = false;
}
$stock_html = '';
if ( $stock ) {
$threshold = Tribe__Settings_Manager::get_option( 'ticket-display-tickets-left-threshold', 0 );
/**
* Overwrites the threshold to display "# tickets left".
*
* @param int $threshold Stock threshold to trigger display of "# tickets left"
* @param array $data Ticket data.
* @param int $event_id Event ID.
*
* @since 4.10.1
*/
$threshold = absint( apply_filters( 'tribe_display_tickets_left_threshold', $threshold, $data, $event_id ) );
if ( ! $threshold || $stock <= $threshold ) {
$number = number_format_i18n( $stock );
if ( 'rsvp' === $type ) {
$text = _n( '%s spot left', '%s spots left', $stock, 'event-tickets' );
} else {
$text = _n( '%s ticket left', '%s tickets left', $stock, 'event-tickets' );
}
$stock_html = '<span class="tribe-tickets-left">'
. esc_html( sprintf( $text, $number ) )
. '</span>';
}
}
$parts[ $type . '-stock' ] = $html['stock'] = $stock_html;
if ( 'rsvp' === $type ) {
$button_label = esc_html_x( 'RSVP Now!', 'list view rsvp now ticket button', 'event-tickets' );
$button_anchor = '#rsvp-now';
} else {
$button_label = esc_html_x( 'Buy Now!', 'list view buy now ticket button', 'event-tickets' );
$button_anchor = '#buy-tickets';
}
$permalink = get_the_permalink( $event_id );
$query_string = parse_url( $permalink, PHP_URL_QUERY );
$query_params = empty( $query_string ) ? array() : (array) explode( '&', $query_string );
$button = '<form method="get" action="' . esc_url( $permalink . $button_anchor ) . '">';
// Add any query attribute as a hidden input as the action of the form is GET
foreach ( $query_params as $param ) {
$parts = explode( '=', $param );
// a query string must be 2 parts only a name and a value
if ( is_array( $parts ) && 2 === count( $parts ) ) {
list( $name, $value ) = $parts;
$button .= '<input type="hidden" name="' . esc_attr( $name ) . '" value="' . esc_attr( $value ) . '">';
}
}
$button .= '<button type="submit" name="tickets_process" class="tribe-button">' . $button_label . '</button></form>';
$parts[ $type . '-button' ] = $html['button'] = $button;
}
}
/**
* Filter the ticket count and purchase button
*
* @since 4.5
*
* @param array $html An array with the final HTML
* @param array $parts An array with all the possible parts of the HTMl button
* @param array $types Ticket and RSVP count array for event
* @param int $event_id Post Event ID
*/
$html = apply_filters( 'tribe_tickets_buy_button', $html, $parts, $types, $event_id );
$html = implode( "\n", $html );
if ( $echo ) {
echo $html;
}
return $html;
}
Changelog
| Version | Description |
|---|---|
| 4.5 | |
| 4.11.3 | Introduced. |