Skip to content

functions

Jump to bottom Edit New page
Jamie Roberts edited this page Apr 8, 2016 · 1 revision

Helper Functions

eventbrite_get_events( $params, $force )

  • Get user-owned events (both public and private are returned by default).
  • $params: (array, optional) Accepted parameters and values
  • $force: (boolean, optional) Force a fresh API call, ignoring any available transient. Default is false.

eventbrite_get_event( $id, $force )

  • Retrieve a single user-owned event.
  • $id: (integer, required) Eventbrite event id
  • $force: (boolean, optional) Force a fresh API call, ignoring any available transient. Default is false.

eventbrite_search( $params, $force )

  • Search all public Eventbrite events.
  • $params: (array, optional) Accepted parameters and values. Note that not passing any parameters, while technically valid, will usually result in timeout errors. Limiting the search to user-owned events can be done by passing user.id => Eventbrite_API::$instance->get_token()->get_meta( 'user_id' ).
  • $force: (boolean, optional) Force a fresh API call, ignoring any available transient. Default is false.

Template Tags

eventbrite_is_single( $query )

  • Determine if we on an Eventbrite single view.
  • $query: (object, optional) Accepts an Eventbrite_Query object.
  • Returns: (boolean) true if the passed or current query is for an event single view, false otherwise.

eventbrite_is_event( $post )

  • Check if a given or current post is an Eventbrite event.
  • $post: (object or integer, optional) Accepts a post/event object, or an ID.
  • Returns: (boolean) true if it's an Eventbrite_Event object or the ID of a valid event, false otherwise.

eventbrite_paging_nav( $events )

  • Output pagination HTML for the index views.
  • Based on wp_paginate_links().
  • $events: (object, required) Requires a valid Eventbrite_Query object. This avoids having to mess with the $wp_query object.

eventbrite_event_meta()

  • Outputs meta information for an event: event time, venue, organizer, and a Details link to the event single view.
  • On the single view, the Details link goes to the event's page on eventbrite.com.

eventbrite_event_time()

  • Output an event's local time, with date, starting, and end time.
  • Example: December 8 2014, 7:00 PM - 10:00 PM

eventbrite_event_venue()

  • Access the current event's venue properties: address, resource_uri, id, name, latitude, longitude

eventbrite_event_organizer()

  • Access the current event's organizer properties: description, logo, resource_uri, id, name, url, num_past_events, num_future_events

eventbrite_event_category()

  • Access the current event's category properties: resource_uri, id, name, name_localized, short_name, short_name_localized

eventbrite_event_subcategory()

  • Access the current event's subcategory properties: resource_uri, id, name, name_localized, short_name, short_name_localized

eventbrite_event_format()

  • Access the current event's format properties: resource_uri, id, name, name_localized, short_name, short_name_localized

eventbrite_event_start()

  • Access the current event's start time properties: timezone, local, utc

eventbrite_event_end()

  • Access the current event's end time properties: timezone, local, utc

eventbrite_ticket_form_widget()

eventbrite_ticket_form_widget_height()

  • Calculates what height an event's ticket form <iframe> should be (pretty rough).
  • Height is calculated with a rough assortment of variables; see here for details.

eventbrite_event_eb_url()

  • Get the URL to the current event on eventbrite.com.
  • Returns: (string) The eventbrite.com URL

eventbrite_is_multiday_event()

  • Checks if the current event spans two or more calendar days (based on UTC time).
  • Returns: (boolean) true if the date is different for the start and end times, false if they're the same.

Filters

eventbrite_templates

  • Adjust the array of valid Eventbrite templates, used for determining body classes.

eventbrite_meta_separator

  • Define the markup used to separate event meta.
  • Default: <span class="sep"> &middot; </span>

eventbrite_event_meta

  • Filter the final HTML for an event's meta info.

eventbrite_paginate_links_args

  • Adjust the arguments passed to the paginate_links() template tag (used by eventbrite_paging_nav()).

eventbrite_event_eb_url

  • Filter an event's URL to its eventbrite.com page.

eventbrite_event_venue

  • Modify the current event's venue properties (see template tag above).

eventbrite_event_organizer

  • Modify the current event's organizer properties (see template tag above).

eventbrite_event_start

  • Modify the current event's start time properties (see template tag above).

eventbrite_event_end

  • Modify the current event's end time properties (see template tag above).

eventbrite_ticket_form_widget

  • Filter the final HTML for the ticket form widgets.

eventbrite_ticket_form_widget_height

  • Adjust the <iframe> height used when outputting a ticket form widget.

eventbrite_api_expansions

  • Adjust the expansions requested on all API calls to Eventbrite.## Functions

Helper Functions

eventbrite_get_events( $params, $force )

  • Get user-owned events (both public and private are returned by default).
  • $params: (array, optional) Accepted parameters and values
  • $force: (boolean, optional) Force a fresh API call, ignoring any available transient. Default is false.

eventbrite_get_event( $id, $force )

  • Retrieve a single user-owned event.
  • $id: (integer, required) Eventbrite event id
  • $force: (boolean, optional) Force a fresh API call, ignoring any available transient. Default is false.

eventbrite_search( $params, $force )

  • Search all public Eventbrite events.
  • $params: (array, optional) Accepted parameters and values. Note that not passing any parameters, while technically valid, will usually result in timeout errors. Limiting the search to user-owned events can be done by passing user.id => Eventbrite_API::$instance->get_token()->get_meta( 'user_id' ).
  • $force: (boolean, optional) Force a fresh API call, ignoring any available transient. Default is false.

Template Tags

eventbrite_is_single( $query )

  • Determine if we on an Eventbrite single view.
  • $query: (object, optional) Accepts an Eventbrite_Query object.
  • Returns: (boolean) true if the passed or current query is for an event single view, false otherwise.

eventbrite_is_event( $post )

  • Check if a given or current post is an Eventbrite event.
  • $post: (object or integer, optional) Accepts a post/event object, or an ID.
  • Returns: (boolean) true if it's an Eventbrite_Event object or the ID of a valid event, false otherwise.

eventbrite_paging_nav( $events )

  • Output pagination HTML for the index views.
  • Based on wp_paginate_links().
  • $events: (object, required) Requires a valid Eventbrite_Query object. This avoids having to mess with the $wp_query object.

eventbrite_event_meta()

  • Outputs meta information for an event: event time, venue, organizer, and a Details link to the event single view.
  • On the single view, the Details link goes to the event's page on eventbrite.com.

eventbrite_event_time()

  • Output an event's local time, with date, starting, and end time.
  • Example: December 8 2014, 7:00 PM - 10:00 PM

eventbrite_event_venue()

  • Access the current event's venue properties: address, resource_uri, id, name, latitude, longitude

eventbrite_event_organizer()

  • Access the current event's organizer properties: description, logo, resource_uri, id, name, url, num_past_events, num_future_events

eventbrite_event_category()

  • Access the current event's category properties: resource_uri, id, name, name_localized, short_name, short_name_localized

eventbrite_event_subcategory()

  • Access the current event's subcategory properties: resource_uri, id, name, name_localized, short_name, short_name_localized

eventbrite_event_format()

  • Access the current event's format properties: resource_uri, id, name, name_localized, short_name, short_name_localized

eventbrite_event_start()

  • Access the current event's start time properties: timezone, local, utc

eventbrite_event_end()

  • Access the current event's end time properties: timezone, local, utc

eventbrite_ticket_form_widget()

eventbrite_ticket_form_widget_height()

  • Calculates what height an event's ticket form <iframe> should be (pretty rough).
  • Height is calculated with a rough assortment of variables; see here for details.

eventbrite_event_eb_url()

  • Get the URL to the current event on eventbrite.com.
  • Returns: (string) The eventbrite.com URL

eventbrite_is_multiday_event()

  • Checks if the current event spans two or more calendar days (based on UTC time).
  • Returns: (boolean) true if the date is different for the start and end times, false if they're the same.

Filters

eventbrite_templates

  • Adjust the array of valid Eventbrite templates, used for determining body classes.

eventbrite_meta_separator

  • Define the markup used to separate event meta.
  • Default: <span class="sep"> &middot; </span>

eventbrite_event_meta

  • Filter the final HTML for an event's meta info.

eventbrite_paginate_links_args

  • Adjust the arguments passed to the paginate_links() template tag (used by eventbrite_paging_nav()).

eventbrite_event_eb_url

  • Filter an event's URL to its eventbrite.com page.

eventbrite_event_venue

  • Modify the current event's venue properties (see template tag above).

eventbrite_event_organizer

  • Modify the current event's organizer properties (see template tag above).

eventbrite_event_start

  • Modify the current event's start time properties (see template tag above).

eventbrite_event_end

  • Modify the current event's end time properties (see template tag above).

eventbrite_ticket_form_widget

  • Filter the final HTML for the ticket form widgets.

eventbrite_ticket_form_widget_height

  • Adjust the <iframe> height used when outputting a ticket form widget.

eventbrite_api_expansions

  • Adjust the expansions requested on all API calls to Eventbrite.
Add a custom footer
Add a custom sidebar
Clone this wiki locally