Documentation Index

• Integrating WEC into your theme

Integrating WEC into your theme

WordPress event calendar was designed to fit into your themes seamlessly. It was designed to use a query object, similiar to the WordPress loop to display your data.

Example:
<?php //You instantiate the query object much as you would a WordPress query $queryObject = new WEC_Query('calendarID=4'); //Start the loop while($queryObject->haveEvents()): $queryObject->the_event(); //display some stuff //End the loop endwhile; ?>

There are many functions you can use to display data from the loop. Calling any of these functions will print the data you call. All these functions also have a get_functionName() that will return the value to you as a variable to do with what you wish.

eventTitle
The eventTitle function prints the title of the event to which this recurrence belongs. theTitle is an alias of this function

eventDescription
The eventDescription function prints the description of the event to which this recurrence belongs. theDescription is an alias of this function

eventExcerpt
The eventExcerpt function prints the excerpt of the event to which this recurrence belongs. theExcerpt is an alias of this function

eventLocation
The eventLocation function prints the location of the event to which this recurrence belongs. theLocation is an alias of this function

eventID
The eventID function prints the ID number of the event to which this recurrence belongs.

recurrenceID
The recurrenceID function prints the ID number of the current recurrence of an event that is being displayed.

startTime
The startTime function prints the time that this event starts. It can accept a PHP date/time format string as an arguement in order to style the time. For documentation on this see: Documentation on date formatting

endTime
The endTime function prints the time that this event ends. It can accept a PHP date/time format string as an arguement in order to style the time. For documentation on this see: Documentation on date formatting

startDate
The startDate function prints the date that this event starts. If this event wraps over more than one day, this will only display the start date, not a range of dates. It can accept a PHP date/time format string as an arguement in order to style the time. For documentation on this see: Documentation on date formatting

endDate
The endDate function prints the date that this event ends. It can accept a PHP date/time format string as an arguement in order to style the time. For documentation on this see: Documentation on date formatting

editLink
Displays an edit link in your template. Clicking it will immediately take you into the admin interface to edit this event. Only visible to users who are logged in. Accepts a string arguement that will change the default link text

Usage

These functions are all members of the WEC_Query object. To use them, inside the loop call the function on the query object.

Example:
<?php while($queryObject->haveEvents()): $queryObject->the_event(); ?> <p><br /> <strong><?php $queryObject->eventTitle(); ?></strong> <br /> <?php $queryObject->eventDescription():?> <?php //End the loop endwhile; ?>