ssi_recentEvents
Description
Displays the specified number of upcoming events or returns this info in an array depending on output_method
Syntax
array ssi_recentEvents ([int $max_events[, string $output_method]])
Parameter $max_events
Expected type: Integer
Description: The maximum number of events to display/return. Default is 7.
Parameter $output_method
Expected type: String
Description: Standard SSI.php output_method variable. If 'echo', the function will simply display the information. Otherwise the information is returned in an array. Default is 'echo'.
Return value
Expected type: Array
Description: Like usual, this function will either display the information in a pre-formatted style or will return an array of the information, depending on output_method.
| Array Elements | |||
| Key | Optional | Expected type | Description |
| can_edit | no | Boolean | Whether or not the user can modify the event |
| href | no | String | The URL of the topic this event is linked to (in 1.1, if the event isn't linked to a topic, this is an empty string) |
| id | no | Integer | Event ID |
| is_last | no | Boolean | Whether or not this is the last event (used to determine when to stop displaying seperators) |
| link | no | String | The link to the appropriate topic, displayed as the event title (empty string in 1.1 if event isn't linked to a topic) |
| modify_href | no | String | The URL to edit the event |
| title | no | String | Event title |
Notes
- Function assumes that most recently posted events are happening farthest in the future
- Only shows events that haven't happened yet
- Events are sorted in descending order by event date
- Uses internal $duplicates array to prevent displaying duplicate events