RS EVENT multiday

“RS EVENT multiday” is an easy to use and highly flexible tool to manage and print posts as events by adding the sidebar-widget “RS EVENT multiday” and/or the functions rs_event_list(), rs_event_post() and rs_event_id(), which can be used in templates. It is based on the original “RS EVENT” by Robert Sargant.

The plugin offers the possibility to add a “RS EVENT multiday” widget to the sidebar of your blog.
It allows you to show a list of upcoming and/or past events.

“RS EVENT multiday” includes three different functions, which can be used in templates.
rs_event_list(), rs_event_post(), rs_event_id()

FUNCTIONS

First of all, the “RS EVENT multiday” widget adds the function rs_event_list() to your sidebar and you can costumize all the settings via the widget control panel at the backend of your blog. If you want to create designated pages to show an event list, you should create a special template file for the theme you use and add the function rs_event_list() manually to the code of your template.

1. rs_event_list()
   This is the function used for the widget. Of course, it can be used in templates as well.
   It prints an unordered list of events according to the parameters given to it (see below).
   Both, the <ul> and the <li> include class=”rsevent”, so you can costumize the output with stylesheets.
   Furthermore, the output can be customized with the parameters “html_list_v1”, “html_list_v2”, “html_list_v3” and “html_list_v4”.
   For details see the parameters-section below.
   Note: If you just want to get the return values from rs_event_list(), so they do not get printed, you should use the function rs_event_list_return().

2. rs_event_post()
   This function should be used in the single-post-template (usually the file single.php of your theme).
   It prints the date of the event.
   The output can be customized with the parameters “html_post_v1”, “html_post_v2”, “html_post_v3” and “html_post_v4”.
   For details see the parameters-section below.
   Note: If you just want to get the return values from rs_event_post(), so they do not get printed, you should use the function rs_event_post_return(). (This might be useful for e.g. Thematic themes.)

3. rs_event_id()
   This function returns an array with IDs of posts, which include event-data. This array of IDs can then be used in other functions or loops.

Each function can be customized by parameters.

PARAMETERS

The parameters are used to customize the functions (see above), if you use them within templates. If you use the sidebar-widget of “RS EVENT multiday”, you can make all the settings via the widget control panel at the backend of your blog.
Please, have a look at the example below (“How to pass on parameters to one of the functions”) in order to see how it works.

title
(string) The widget-title in your sidebar. Not used, when the function is added to a template.
default value: ‘Upcoming Events’

timespan
(integer) The maximum distance into the future events will be retrieved for, in days.
default value: 365

history
(integer) The maximum distance into the past that events will be retrieved for, in days. This can also be set to a negative negative number, e.g. -2 to prevent events that are occuring in the next two days from appearing.
default value: 0

date_format_1
(string) The style in which the date is formatted. date_format_1 is used for single-day events, for the end date of multi-day events, and for the start date of multi-day events if the two dates are NOT within the same year.
default value: ‘d.m.Y’

date_format_2
(string) The style in which the date is formatted. date_format_2 is used for the start date of multi-day events if the two dates are within the same year.
default value: ‘d.m.’

groupdateformat_y
(string) The style in which the yearly headline date is formatted, if events are grouped by year. See also parameter group_by_year.
default value: ‘Y’

groupdateformat_m
(string) The style in which the monthly headline date is formatted, if events are grouped by month. See also parameter group_by_month.
default value: ‘F’

Read the full description on the official page →