ssi_todaysCalendar

Description

A combination of the other three calendar functions. This will display all upcoming holidays, birthdays and events, or return an array containing three arrays - one for each type of item.

Syntax

array ssi_todaysCalendar ([string $output_method])


Parameter $output_method

Expected type: String
Description: The standard SSI.php output_method variable. If set to 'echo', the function will display the results in a pre-formatted style. Otherwise it will return an array of the information. Default is 'echo'.


Return value

Expected type: Array
Description: If output_method is 'echo', the information is simply displayed. Otherwise it is returned as an array of arrays.

Array Elements
Key Optional Expected type Description
birthdays no Array An array containing information about any upcoming/current birthdays (see ssi_todaysBirthdays for more info)
events no Array An array containing information about upcoming/current events (see ssi_todaysEvents for more info)
holidays no Array An array containing information about upcoming/current holidays (see ssi_todaysHolidays for more info)


Notes

  • See the appropriate function for specific information about what's available for each type of item
  • Returns an empty array if the calendar is disabled or the info couldn't be loaded
  • If output_method is 'echo', only outputs information if there's something to show
View all versions of this function
Advertisement: