Event Organiser Codex

Packages

  • admin-calendar
  • booking-form
  • booking-form-template-functions
  • booking-functions
  • booking-status
  • deprecated
  • event-date-functions
  • event-functions
  • event-query-functions
  • fullCalendar
  • general-functions
  • ical-functions
  • payment-gateway
  • template-functions
  • ticket-functions
  • user-booking-functions
  • utility-functions
  • venue-functions

Functions

  • eo_get_venue_permastructure
  • eo_get_events
  • eo_get_the_start
  • eo_get_the_occurrence
  • eo_the_start
  • eo_get_the_end
  • eo_the_end
  • eo_get_next_occurrence
  • eo_get_next_occurrence_of
  • eo_next_occurrence
  • eo_get_current_occurrence_of
  • eo_is_all_day
  • eo_get_schedule_start
  • eo_schedule_start
  • eo_get_schedule_last
  • eo_schedule_last
  • eo_recurs
  • eo_get_the_occurrences_of
  • eo_get_category_color
  • eo_get_event_color
  • eo_get_event_textcolor
  • eo_get_event_classes
  • eo_is_event_taxonomy
  • eo_get_events_feed
  • eo_get_event_category_feed
  • eo_get_event_venue_feed
  • eo_get_add_to_google_link
  • eo_get_event_fullcalendar
  • eo_get_the_occurrence_id
  • eo_get_permalink
  • eo_get_event_archive_link
  • eo_break_occurrence
  • eo_get_event_uid
  • eo_get_event_datetime_format
  • eo_update_event
  • eo_insert_event
  • eo_delete_event_occurrences
  • eo_get_event_schedule
  • eo_get_the_GoogleLink
  • eo_get_the_occurrences
  • eo_is_allday
  • eo_get_schedule_end
  • eo_schedule_end
  • eo_get_reoccurrence
  • eo_get_reoccurence
  • eo_reoccurs
  • eo_event_color
  • eo_get_the_venues
  • eo_php2xdate
  • eo_get_venue
  • eo_get_venue_slug
  • eo_get_venue_id_by_slugorid
  • eo_get_venue_by
  • eo_get_venue_name
  • eo_venue_name
  • eo_get_venue_description
  • eo_venue_description
  • eo_get_venue_excerpt
  • eo_get_venue_latlng
  • eo_get_venue_lat
  • eo_get_venue_lng
  • eo_venue_lat
  • eo_venue_lng
  • eo_venue_has_latlng
  • eo_get_venue_link
  • eo_venue_link
  • eo_get_venue_address
  • eo_get_venues
  • eo_update_venue
  • eo_insert_venue
  • eo_delete_venue
  • eo_get_venue_map
  • eo_get_venue_meta
  • eo_add_venue_meta
  • eo_update_venue_meta
  • eo_delete_venue_meta
  • eo_get_category_meta
  • eo_get_template_part
  • eo_locate_template
  • eo_register_style
  • eo_enqueue_style
  • eo_is_event_archive
  • eo_get_event_archive_date
  • eo_format_datetime
  • eo_format_date
  • eo_format_datetime_range
  • eo_format_event_occurrence
  • eo_get_blog_timezone
  • eo_date_interval
  • eo_php_to_moment
  • eo_php2jquerydate
  • eo_check_datetime
  • eo_color_luminance
  • eo_blog_is_24
  • eo_blog_is_using_ordinal
  • eo_list_pluck_key_value
  • eo_array_key_whitelist
  • eo_is_multi_event_organiser
  • eo_array_combine_assoc
  • eo_get_user_id_by
  • from_camel_case
  • eo_get_event_tickets
  • eo_get_event_tickets_on_sale
  • eo_get_ticket
  • eo_get_event_capacity
  • eo_is_event_free
  • eo_get_booking_form
  • eo_signup_form
  • eo_get_booking_tickets
  • eo_get_booking_ticket_meta
  • eo_add_booking_ticket_meta
  • eo_update_booking_ticket_meta
  • eo_delete_booking_ticket_meta
  • eo_get_booking_tickets_cid
  • eo_get_remaining_tickets_count
  • eo_remote_geocode
  • eo_get_event_search_form
  • eo_get_booking_form_total_placholder
  • eo_get_booking_form_quantity_placholder
  • eo_booking_form_ticket_data_attr
  • eo_get_booking_occurrence_picker
  • eo_form_select_month
  • eo_form_select_year
  • eo_get_venue_thumbnail_id
  • eo_set_venue_thumbnail
  • eo_delete_venue_thumbnail
  • eo_get_venue_thumbnail
  • eo_format_price
  • eo_get_currency_symbol
  • eo_get_currencies
  • eo_login_by_email
  • eo_get_admin_email
  • eo_get_booking_notification_email
  • eo_sanitize_name
  • eo_insert_booking
  • eo_get_booking_date
  • eo_get_booking_event_start_date
  • eo_get_booking_meta
  • eo_get_bookings
  • eo_cancel_booking
  • eo_restore_booking
  • eo_delete_booking
  • eo_confirm_booking
  • eo_get_booking_status
  • eo_user_has_bookings
  • eo_get_events_user_is_attending
  • eo_number_events_user_is_attending
  • eo_get_user_booking_history
  • eo_register_booking_status
  • eo_get_reserved_booking_statuses
  • eo_get_confirmed_booking_statuses
  • eo_get_booking_statuses

Classes

  • EventOrganiser_Debugger
  • EO_Theme_Compatabilty
  • Event_Organiser_Im_Export
  • EO_ICAL_Parser
  • EO_Walker_TaxonomyDropdown
  • EO_Venue_List_Table
  • EO_Widget_Categories
  • EO_Event_List_Widget
  • EO_Events_Agenda_Widget
  • EO_Calendar_Widget
  • EO_Payment_Gateway
  • EO_Bookee_Storage
  • EO_Bookee_WPUser
  • EO_Bookee_Guest
  • EO_Money
  • EO_Event_Ticket_Type
  • EO_Bookable_EventSeries
  • EO_Bookable_CapacityException
  • EO_Bookable_EventOccurrence
  • EO_Bookable_Event
  • EO_Currency
  • EO_Query_Result
  • EO_Booking
  • EO_Email_Template_Tag_Registry
  • EO_AbstractCSV
  • EO_Booking_Form_Element
  • EO_Booking_Form_Element_Google_Recaptcha
  • EO_Booking_Form_Element_Total
  • EO_Booking_Form_Element_Factory
  • EO_Booking_Form_Elements_View
  • EO_Booking_Form_Validate_Visitor
  • EO_Booking_Form_JSON_Visitor
  • EO_Booking_Form_Element_View
  • EO_Booking_Form_Element_AttendeeQuestions_View
  • EO_Booking_Form_Element_Google_Recaptcha_View
  • EO_Booking_Form_Element_Total_View
  • EO_Booking_Form_View
  • EO_Booking_Form_Save_Visitor
  • EO_Booking_Form_Factory
  • EO_Booking_Form_Visitor
  • EO_Booking_Form
  • EO_Date_Range
  • EO_Booking_Status
  • EO_Booking_Status_Reserved
  • EO_Booking_Status_Confirmed
  • EO_Booking_Status_Unreserved
  • EO_Booking_Ticket_Storage
  • EO_Booking_Ticket_Factory
  • EO_Booking_Ticket_Query
  • EO_Booking_Ticket_CSV
  • EO_Booking_Grouped_Ticket
  • EO_Booking_Storage
  • EO_Booking_Factory
  • EO_Booking_Query
  • EO_Booking_CSV
  • EO_Booking_Ticket
  • EO_Export_SimpleController
  • EO_Export_Controller
  • EO_Export_Booking_Ticket_Controller
  • EO_Export_Booking_Controller
  • EO_Export_BatchController
  • EO_Bookee

Hooks

  • eventorganiser_save_event
  • eventorganiser_options
  • eventorganiser_additional_event_meta
  • eventorganiser_ical_description
  • eventorganiser_get_the_start
  • eventorganiser_get_the_end
  • eventorganiser_get_next_occurrence
  • eventorganiser_get_schedule_start
  • eventorganiser_get_schedule_last
  • eventorganiser_get_the_future_occurrences_of
  • eventorganiser_get_the_occurrences_of
  • eventorganiser_event_color
  • eventorganiser_event_classes
  • eventorganiser_event_meta_list
  • eventorganiser_get_permalink
  • eventorganiser_pre_break_occurrence
  • eventorganiser_breaking_occurrence_exclude_meta
  • eventorganiser_occurrence_broken
  • eventorganiser_updated_event
  • eventorganiser_created_event
  • eventorganiser_delete_event_occurrences
  • eventorganiser_get_event_schedule
  • eventorganiser_generate_occurrences
  • eventorganiser_fullcalendar_query
  • eventorganiser_fullcalendar
  • eventorganiser_calendar_event_link
  • eventorganiser_event_tooltip
  • eventorganiser_fullcalendar_event
  • eventorganiser_admin_cal_summary
  • eventorganiser_admin_fullcalendar_event
  • eventorganiser_is_event_query
  • eventorganiser_venue_excerpt
  • eventorganiser_save_venue
  • eventorganiser_pre_insert_venue
  • eventorganiser_insert_venue
  • eventorganiser_venue_deleted
  • eventorganiser_venue_tooltip
  • eventorganiser_venue_marker
  • eventorganiser_venue_map_options
  • eventorganiser_venue_address_fields
  • eventorganiser_register_taxonomy_event-venue
  • eventorganiser_register_taxonomy_event-category
  • eventorganiser_register_taxonomy_event-tag
  • eventorganiser_menu_position
  • eventorganiser_event_properties
  • eventorganiser_template_stack
  • eventorganiser_stylesheet_src
  • eventorganiser_stylesheet_src_{$handle}
  • eventorganiser_stylesheet_handle_{$handle}
  • eventorganiser_pre_event_content
  • eventorganiser_format_datetime
  • eventorganiser_format_datetime_string
  • eventorganiser_timezone
  • eventorganiser_trim_excerpt
  • eventorganiser_blog_is_24
  • eventorganiser_blog_is_using_ordinal
  • eventorganiser_is_multi_event_organiser
  • eventorganiser_google_maps_url
  • eventorganiser_events_expire_time
  • eventorganiser_event_metabox_notice
  • eventorganiser_metabox_after_core_fields
  • eventorganiser_pre_booking_history
  • eventorganiser_booking_history_header_before
  • eventorganiser_booking_history_header_after
  • eventorganiser_booking_history_header_row_start
  • eventorganiser_booking_history_header_row_end
  • eventorganiser_post_booking_history
  • eventorganiser_booking_pre_total_row
  • eventorganiser_booking_closed
  • eventorganiser_booking_tickets_sold_out
  • eventorganiser_booking_login_required
  • eventorganiser_ticket_options_after
  • eventorganiser_booking_metabox_pre_tickets
  • eventorganiser_booking_metabox_post_tickets
  • eventorganiser_booking_metabox_bottom
  • eventorganiser_get_event_tickets
  • eventorganiser_get_event_ticket_meta
  • eventorganiser_insert_event_ticket
  • eventorganiser_update_event_ticket
  • eventorganiser_delete_booking_ticket
  • eventorganiser_deleted_booking_ticket
  • eventorganiser_booking_ticket_reference
  • eventorganiser_bookable_occurrences
  • eventorganiser_remote_geocode
  • eventorganiser_enabled_gateways
  • eventorganiser_notify_new_booking_message
  • eventorganiser_notify_new_booking_subject
  • eventorganiser_transition_booking_status
  • eventorganiser_notify_confirmed_booking
  • eventorganiser_booking_confirmed_email_subject
  • eventorganiser_booking_confirmed_email_body
  • eventorganiser_booking_confirmed_email_headers
  • eventorganiser_booking_confirmed_email_attachments
  • eventorganiser_booking_confirmed_email_template
  • eventorganiser_notify_confirmed_booking_message
  • eventorganiser_notify_confirmed_booking_subject
  • eventorganiser_bookee_username
  • eventorganiser_can_cancel_booking_before
  • eventorganiser_format_price
  • eventorganiser_admin_email
  • eventorganiser_booking_notification_email
  • eventorganiser_new_booking
  • eventorganiser_cancel_booking
  • eventorganiser_cancelled_booking
  • eventorganiser_restore_booking
  • eventorganiser_restored_booking
  • eventorganiser_delete_booking
  • eventorganiser_deleted_booking
  • eventorganiser_confirm_booking
  • eventorganiser_confirmed_booking
  • eventorganiser_change_booking_occurrence
  • eventorganiser_event_map_tooltip

eo_get_the_start since 1.0.0

eo_get_the_start( $format = 'd-m-Y', $post_id, $occurrence_id, $deprecated )
  • Located: event-organiser/includes/event-organiser-event-functions.php - line 228
  • Package: event-date-functions

Returns the start date of occurrence of event.

If used inside the loop, with no id no set, returns start date of current event occurrence.

3.0.0 Update: This function used to accept 4 arguments (versions 1.5.6 - 2.11.1), with the third (null) argument deprecated. While the old behaviour shall still work, it is recommended that pass a maximum of three arguments, as shown below, with the third argument (not the fourth) specifying the occurrence ID.

Examples

Inside the loop, you can output the start date of event (occurrence)

<?php echo eo_get_the_start( 'jS M Y' ); ?>

Get the start date of the event with id 7 and occurrence ID 3

<?php $date = eo_get_the_start ( 'jS M Y', 7, 3 ); ?>

Print a list of upcoming events with their start and end date

//Get upcoming events
    $events = eo_get_events(array(
         'numberposts'        => 5,
         'events_start_after' => 'today',
         'showpastevents'     => true,
      ));

    if( $events ){
        echo '<ul>';
        foreach( $events as $event ){
          printf("<li><a href='%s' >%s</a> from %s to %s </li>",
               get_the_permalink( $post->ID ),
               get_the_title( $post->ID ),
               eo_get_the_start( 'jS F Y', $post->ID, $post->occurrence_id ),
               eo_get_the_end( 'jS F Y', $post->ID, $post->occurrence_id )
          );
         }
        echo '</ul>';
    }else{
        echo 'No Upcoming Events';
    }

Parameters

string $format = 'd-m-Y'

String of format as accepted by PHP date or the constant DATETIMEOBJ to return a DateTime object

int $post_id

Post ID of the event

int $occurrence_id

The occurrence ID

int $deprecated

(Was) the occurrence id, supply this as the third argument

Return value

string|\DateTime

the start date formated to given format, as accepted by PHP date or a DateTime object if DATETIMEOBJ is given as format.

Hooks

filter eventorganiser_get_the_start

Changelog

3.0.0

Third argument repurposed for the occurrence ID. Fourth argument can still be used, but discouraged.

1.5.6

Third argument deprecated, use fourth argument to pass occurrence ID.

1.0.0

© Copyright 2019 by Canalside Digital. Documentation last updated 6th June 2019, 9:44pm.