ssi_todaysBirthdays

Description

Shows a list of current and upcoming birthdays from the calendar, or returns an array of such information if output_method isn't 'echo'.

Syntax

array ssi_todaysBirthdays ([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 function will simply output a list of birthdays (if any). Otherwise an array with the following details will be returned.

Array Elements
Key Optional Expected type Description
age no Integer Member's age, if it's set
id no Integer ID of the member
is_last no Boolean True if this is the last item in the array, false otherwise (used to determine when to stop showing seperators)
is_today no Boolean True if today is the member's birthday, false otherwise
name no String The member's display name


View all versions of this function
Advertisement: