/include/CalendarSolution/wordpress_shortcodes.php

Description

Calendar Solution's API for WordPress Shortcodes

WordPress has Shortcode functionality built in as of version 2.5.

The following Attributes are available for use with all Shortcodes. Some formats have additional Attributes; see the documentation for each function for more details.

 # Examples
 # MonthTitle, date dropdown list on top, date navigation on bottom.
 [calendar_solution_monthtitle limit_form_top="datelist" date_navigation_bottom=""]

 # QuickTable, five rows, navigation for more events on the bottom.
 [calendar_solution_quicktable frequent_event_id="6" limit="5,null" limit_navigation_bottom=""]

Calendar Solution is a trademark of The Analysis and Solutions Company.

Includes
require (dirname(dirname(__FILE__)).'/calendar_solution_settings.php') (line 84)

Obtain the Calendar Solution's settings and autoload function

Functions
calendar_solution_calendar (line 111)

Shortcode handler for producing a list of events laid out in a calendar grid format

See CalendarSolution_List_Calendar::get_rendering() for more details regarding this format.

See wordpress_shortcodes.php for a list of attributes that can be used with this shortcode.

This shortcode has additional optional attributes:

  • return: the desired HTML
  • since: Function available since version 3.3
string calendar_solution_calendar (array $atts)
  • array $atts: the attributes used in the current shortcode call
calendar_solution_detailtable (line 150)

Shortcode handler for producing a table of events showing details about each entry

See CalendarSolution_List_DetailTable::get_rendering() for more details regarding this format.

See wordpress_shortcodes.php for a list of attributes that can be used with this shortcode.

This shortcode has additional optional attributes:

  • show_time_end: CalendarSolution_List::set_show_time_end()

  • return: the desired HTML
  • since: Function available since version 3.4
string calendar_solution_detailtable (array $atts)
  • array $atts: the attributes used in the current shortcode call
calendar_solution_list (line 189)

Shortcode handler for producing a table of events showing significant info about each event

See CalendarSolution_List_List::get_rendering() for more details regarding this format.

See wordpress_shortcodes.php for a list of attributes that can be used with this shortcode.

This shortcode has additional optional attributes:

  • return: the desired HTML
  • since: Function available since version 3.3
string calendar_solution_list (array $atts)
  • array $atts: the attributes used in the current shortcode call
calendar_solution_monthtitle (line 228)

Shortcode handler for producing a table of events showing their dates and names, grouped by month

See CalendarSolution_List_MonthTitle::get_rendering() for more details regarding this format.

See wordpress_shortcodes.php for a list of attributes that can be used with this shortcode.

This shortcode has additional optional attributes:

  • return: the desired HTML
  • since: Function available since version 3.3
string calendar_solution_monthtitle (array $atts)
  • array $atts: the attributes used in the current shortcode call
calendar_solution_quicktable (line 263)

Shortcode handler for producing a table of events showing basic info about each entry

See CalendarSolution_List_QuickTable::get_rendering() for more details regarding this format.

See wordpress_shortcodes.php for a list of attributes that can be used with this shortcode.

This shortcode has additional optional attributes:

  • show_time_end: CalendarSolution_List::set_show_time_end()

  • return: the desired HTML
  • since: Function available since version 3.3
string calendar_solution_quicktable (array $atts)
  • array $atts: the attributes used in the current shortcode call
calendar_solution_title (line 298)

Shortcode handler for producing a table of events showing their dates and names

See CalendarSolution_List_Title::get_rendering() for more details regarding this format.

See wordpress_shortcodes.php for a list of attributes that can be used with this shortcode.

  • return: the desired HTML
  • since: Function available since version 3.3
string calendar_solution_title (array $atts)
  • array $atts: the attributes used in the current shortcode call
calendar_solution_ul (line 329)

Shortcode handler for producing an "unordered list" of events showing their dates and names

See CalendarSolution_List_Ul::get_rendering() for more details regarding this format.

See wordpress_shortcodes.php for a list of attributes that can be used with this shortcode.

  • return: the desired HTML
  • since: Function available since version 3.3
string calendar_solution_ul (array $atts)
  • array $atts: the attributes used in the current shortcode call

Documentation generated on Wed, 21 Mar 2012 14:16:45 -0400 by phpDocumentor 1.4.4