getEventRange

Description

Gets all events occurring in the specified range of dates

Syntax

array getEventRange (string $low_date, string $high_date[, bool $use_permissions])


Parameter $low_date

Expected type: String
Description: The low end of the date range.


Parameter $high_date

Expected type: String
Description: The high end of the date range


Parameter $use_permissions

Expected type: Boolean
Description: Whether or not to only pull events that the current user can see. Default is true.


Return value

Expected type: Array of arrays
Description: Returns an array with arrays of event info happening on a specific day. Main key is the date (in YYYY-MM-DD format), and each array may contain one or more arrays with information about the events happening on that day. See code for specifics.


Notes

  • Both the earliest_date and latest_date should be in the standard YYYY-MM-DD format.
  • Censors the posted event titles.
  • Uses the current user's permissions if use_permissions is true, otherwise it does nothing "permission specific".
  • Returns an array of contextual information if use_permissions is true, and an array of the data needed to build that otherwise.
View all versions of this function
Advertisement: