Location: PHPKode > scripts > Calendar Solution > convissor-calendar_solution-ff69243/include/CalendarSolution/doc/phpdoc-output/CalendarSolution/_include---CalendarSolution---wordpress_shortcodes.php.html
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs for page wordpress_shortcodes.php</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="file-name">/include/CalendarSolution/wordpress_shortcodes.php</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
									<a href="#sec-includes">Includes</a>
			|											<a href="#sec-functions">Functions</a>
			</div>
	<div class="info-box-body">	
		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Calendar Solution's API for WordPress Shortcodes</p>
<p class="description"><p>WordPress has Shortcode functionality built in as of version 2.5.</p><p><ul><li>calendar_solution_calendar: <a href="../CalendarSolution/_include---CalendarSolution---wordpress_shortcodes.php.html#functioncalendar_solution_calendar">calendar_solution_calendar()</a></li><li>calendar_solution_detailtable: <a href="../CalendarSolution/_include---CalendarSolution---wordpress_shortcodes.php.html#functioncalendar_solution_detailtable">calendar_solution_detailtable()</a></li><li>calendar_solution_list: <a href="../CalendarSolution/_include---CalendarSolution---wordpress_shortcodes.php.html#functioncalendar_solution_list">calendar_solution_list()</a></li><li>calendar_solution_monthtitle: <a href="../CalendarSolution/_include---CalendarSolution---wordpress_shortcodes.php.html#functioncalendar_solution_monthtitle">calendar_solution_monthtitle()</a></li><li>calendar_solution_quicktable: <a href="../CalendarSolution/_include---CalendarSolution---wordpress_shortcodes.php.html#functioncalendar_solution_quicktable">calendar_solution_quicktable()</a></li><li>calendar_solution_title: <a href="../CalendarSolution/_include---CalendarSolution---wordpress_shortcodes.php.html#functioncalendar_solution_title">calendar_solution_title()</a></li><li>calendar_solution_ul: <a href="../CalendarSolution/_include---CalendarSolution---wordpress_shortcodes.php.html#functioncalendar_solution_ul">calendar_solution_ul()</a></li></ul></p><p>The following Attributes are available for use with all Shortcodes.  Some formats have additional Attributes; see the documentation for each  function for more details.</p><p><ul><li>Attributes to get data by ID:  <ul><li>category_id: <a href="../CalendarSolution/CalendarSolution_List.html#methodset_category_id">CalendarSolution_List::set_category_id()</a></li><li>frequent_event_id: <a href="../CalendarSolution/CalendarSolution_List.html#methodset_frequent_event_id">CalendarSolution_List::set_frequent_event_id()</a></li><li>page_id: <a href="../CalendarSolution/CalendarSolution_List.html#methodset_page_id">CalendarSolution_List::set_page_id()</a></li></ul></li><li>Attributes to limit the number of results:  <ul><li>limit: <a href="../CalendarSolution/CalendarSolution_List.html#methodset_limit">CalendarSolution_List::set_limit()</a></li></ul></li><li>Attributes to get data a user is seeking:  <ul><li>request_properties: <a href="../CalendarSolution/CalendarSolution_List.html#methodset_request_properties">CalendarSolution_List::set_request_properties()</a></li></ul></li><li>Attributes for displaying navigation elements:  <ul><li>date_navigation_top / date_navigation_bottom: <a href="../CalendarSolution/CalendarSolution_List.html#methodget_date_navigation">CalendarSolution_List::get_date_navigation()</a></li><li>limit_form_top / limit_form_bottom: <a href="../CalendarSolution/CalendarSolution_List.html#methodget_limit_form">CalendarSolution_List::get_limit_form()</a></li><li>limit_navigation_bottom: <a href="../CalendarSolution/CalendarSolution_List.html#methodget_limit_navigation">CalendarSolution_List::get_limit_navigation()</a></li></ul></li><li>Attributes for formatting data:  <ul><li>date_format: <a href="../CalendarSolution/CalendarSolution_List.html#methodset_date_format">CalendarSolution_List::set_date_format()</a></li><li>time_format: <a href="../CalendarSolution/CalendarSolution_List.html#methodset_time_format">CalendarSolution_List::set_time_format()</a></li><li>show_cancelled: <a href="../CalendarSolution/CalendarSolution_List.html#methodset_show_cancelled">CalendarSolution_List::set_show_cancelled()</a></li><li>is_own_event: <a href="../CalendarSolution/CalendarSolution_List.html#methodset_is_own_event">CalendarSolution_List::set_is_own_event()</a></li><li>show_own_events_first: <a href="../CalendarSolution/CalendarSolution_List.html#methodset_show_own_events_first">CalendarSolution_List::set_show_own_events_first()</a></li></ul></li><li>Attributes for limiting data by date (the defaults are sane; use only
 when necessary):  <ul><li>from: <a href="../CalendarSolution/CalendarSolution_List.html#methodset_from">CalendarSolution_List::set_from()</a></li><li>to: <a href="../CalendarSolution/CalendarSolution_List.html#methodset_to">CalendarSolution_List::set_to()</a></li><li>permit_history_months: <a href="../CalendarSolution/CalendarSolution_List.html#methodset_permit_history_months">CalendarSolution_List::set_permit_history_months()</a></li><li>permit_future_months: <a href="../CalendarSolution/CalendarSolution_List.html#methodset_permit_future_months">CalendarSolution_List::set_permit_future_months()</a></li></ul></li></ul></p><p><pre> # 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=""]</pre></p><p>Calendar Solution is a trademark of The Analysis and Solutions Company.</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Daniel Convissor &lt;<a href="mailto:hide@address.com">hide@address.com</a>&gt;</li>
				<li><span class="field">copyright:</span> The Analysis and Solutions Company, 2002-2012</li>
				<li><span class="field">link:</span> <a href="http://codex.wordpress.org/Shortcode_API">http://codex.wordpress.org/Shortcode_API</a></li>
				<li><span class="field">license:</span> <a href="http://www.analysisandsolutions.com/software/license.htm">Simple Public License</a></li>
			</ul>
		
			</div>
</div>
		

	<a name="sec-includes"></a>	
	<div class="info-box">
		<div class="info-box-title">Includes</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Includes</span>
			|													<a href="#sec-functions">Functions</a>
					</div>
		<div class="info-box-body">	
			<a name="_dirname(dirname(__FILE__))_/calendar_solution_settings_php"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="include-title">
			<span class="include-type">require</span>
			(<span class="include-name">dirname(dirname(__FILE__)).'/calendar_solution_settings.php'</span>)
			(line <span class="line-number">84</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Obtain the Calendar Solution's settings and autoload function</p>
	
</div>
		</div>
	</div>
	
	
	
	<a name="sec-functions"></a>	
	<div class="info-box">
		<div class="info-box-title">Functions</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-includes">Includes</a>
				|												<span class="disabled">Functions</span>
		</div>
		<div class="info-box-body">	
			<a name="functioncalendar_solution_calendar" id="functioncalendar_solution_calendar"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="method-title">calendar_solution_calendar</span> (line <span class="line-number">111</span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Shortcode handler for producing a list of events laid out in a calendar  grid format</p>
<p class="description"><p>See <a href="../CalendarSolution/CalendarSolution_List_Calendar.html#methodget_rendering">CalendarSolution_List_Calendar::get_rendering()</a> for more  details regarding this format.</p><p>See <a href="../CalendarSolution/_include---CalendarSolution---wordpress_shortcodes.php.html">wordpress_shortcodes.php</a> for a list of  attributes that can be used with this shortcode.</p><p>This shortcode has additional optional attributes: <ul><li>show_location: <a href="../CalendarSolution/CalendarSolution_List.html#methodset_show_location">CalendarSolution_List::set_show_location()</a></li><li>months: <a href="../CalendarSolution/CalendarSolution_List.html#method__construct">CalendarSolution_List::__construct()</a></li></ul></p></p>
	<ul class="tags">
				<li><span class="field">return:</span> the desired HTML</li>
				<li><span class="field">since:</span> Function available since version 3.3</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			calendar_solution_calendar
		</span>
					(<span class="var-type">array</span>&nbsp;<span class="var-name">$atts</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$atts</span><span class="var-description">: the attributes used in the current shortcode call</span>			</li>
				</ul>
		
	
</div>
<a name="functioncalendar_solution_detailtable" id="functioncalendar_solution_detailtable"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="method-title">calendar_solution_detailtable</span> (line <span class="line-number">150</span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Shortcode handler for producing a table of events showing details  about each entry</p>
<p class="description"><p>See <a href="../CalendarSolution/CalendarSolution_List_DetailTable.html#methodget_rendering">CalendarSolution_List_DetailTable::get_rendering()</a> for more  details regarding this format.</p><p>See <a href="../CalendarSolution/_include---CalendarSolution---wordpress_shortcodes.php.html">wordpress_shortcodes.php</a> for a list of  attributes that can be used with this shortcode.</p><p>This shortcode has additional optional attributes: <ul><li>show_time_end: CalendarSolution_List::set_show_time_end()</li></ul></p></p>
	<ul class="tags">
				<li><span class="field">return:</span> the desired HTML</li>
				<li><span class="field">since:</span> Function available since version 3.4</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			calendar_solution_detailtable
		</span>
					(<span class="var-type">array</span>&nbsp;<span class="var-name">$atts</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$atts</span><span class="var-description">: the attributes used in the current shortcode call</span>			</li>
				</ul>
		
	
</div>
<a name="functioncalendar_solution_list" id="functioncalendar_solution_list"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="method-title">calendar_solution_list</span> (line <span class="line-number">189</span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Shortcode handler for producing a table of events showing significant  info about each event</p>
<p class="description"><p>See <a href="../CalendarSolution/CalendarSolution_List_List.html#methodget_rendering">CalendarSolution_List_List::get_rendering()</a> for more  details regarding this format.</p><p>See <a href="../CalendarSolution/_include---CalendarSolution---wordpress_shortcodes.php.html">wordpress_shortcodes.php</a> for a list of  attributes that can be used with this shortcode.</p><p>This shortcode has additional optional attributes: <ul><li>show_summary: <a href="../CalendarSolution/CalendarSolution_List.html#methodset_show_summary">CalendarSolution_List::set_show_summary()</a></li><li>months: <a href="../CalendarSolution/CalendarSolution_List.html#method__construct">CalendarSolution_List::__construct()</a></li></ul></p></p>
	<ul class="tags">
				<li><span class="field">return:</span> the desired HTML</li>
				<li><span class="field">since:</span> Function available since version 3.3</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			calendar_solution_list
		</span>
					(<span class="var-type">array</span>&nbsp;<span class="var-name">$atts</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$atts</span><span class="var-description">: the attributes used in the current shortcode call</span>			</li>
				</ul>
		
	
</div>
<a name="functioncalendar_solution_monthtitle" id="functioncalendar_solution_monthtitle"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="method-title">calendar_solution_monthtitle</span> (line <span class="line-number">228</span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Shortcode handler for producing a table of events showing their dates  and names, grouped by month</p>
<p class="description"><p>See <a href="../CalendarSolution/CalendarSolution_List_MonthTitle.html#methodget_rendering">CalendarSolution_List_MonthTitle::get_rendering()</a> for more  details regarding this format.</p><p>See <a href="../CalendarSolution/_include---CalendarSolution---wordpress_shortcodes.php.html">wordpress_shortcodes.php</a> for a list of  attributes that can be used with this shortcode.</p><p>This shortcode has additional optional attributes: <ul><li>months: <a href="../CalendarSolution/CalendarSolution_List.html#method__construct">CalendarSolution_List::__construct()</a></li></ul></p></p>
	<ul class="tags">
				<li><span class="field">return:</span> the desired HTML</li>
				<li><span class="field">since:</span> Function available since version 3.3</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			calendar_solution_monthtitle
		</span>
					(<span class="var-type">array</span>&nbsp;<span class="var-name">$atts</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$atts</span><span class="var-description">: the attributes used in the current shortcode call</span>			</li>
				</ul>
		
	
</div>
<a name="functioncalendar_solution_quicktable" id="functioncalendar_solution_quicktable"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="method-title">calendar_solution_quicktable</span> (line <span class="line-number">263</span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Shortcode handler for producing a table of events showing basic info  about each entry</p>
<p class="description"><p>See <a href="../CalendarSolution/CalendarSolution_List_QuickTable.html#methodget_rendering">CalendarSolution_List_QuickTable::get_rendering()</a> for more  details regarding this format.</p><p>See <a href="../CalendarSolution/_include---CalendarSolution---wordpress_shortcodes.php.html">wordpress_shortcodes.php</a> for a list of  attributes that can be used with this shortcode.</p><p>This shortcode has additional optional attributes: <ul><li>show_time_end: CalendarSolution_List::set_show_time_end()</li></ul></p></p>
	<ul class="tags">
				<li><span class="field">return:</span> the desired HTML</li>
				<li><span class="field">since:</span> Function available since version 3.3</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			calendar_solution_quicktable
		</span>
					(<span class="var-type">array</span>&nbsp;<span class="var-name">$atts</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$atts</span><span class="var-description">: the attributes used in the current shortcode call</span>			</li>
				</ul>
		
	
</div>
<a name="functioncalendar_solution_title" id="functioncalendar_solution_title"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="method-title">calendar_solution_title</span> (line <span class="line-number">298</span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Shortcode handler for producing a table of events showing their dates  and names</p>
<p class="description"><p>See <a href="../CalendarSolution/CalendarSolution_List_Title.html#methodget_rendering">CalendarSolution_List_Title::get_rendering()</a> for more  details regarding this format.</p><p>See <a href="../CalendarSolution/_include---CalendarSolution---wordpress_shortcodes.php.html">wordpress_shortcodes.php</a> for a list of  attributes that can be used with this shortcode.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> the desired HTML</li>
				<li><span class="field">since:</span> Function available since version 3.3</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			calendar_solution_title
		</span>
					(<span class="var-type">array</span>&nbsp;<span class="var-name">$atts</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$atts</span><span class="var-description">: the attributes used in the current shortcode call</span>			</li>
				</ul>
		
	
</div>
<a name="functioncalendar_solution_ul" id="functioncalendar_solution_ul"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="method-title">calendar_solution_ul</span> (line <span class="line-number">329</span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Shortcode handler for producing an &quot;unordered list&quot; of events showing  their dates and names</p>
<p class="description"><p>See <a href="../CalendarSolution/CalendarSolution_List_Ul.html#methodget_rendering">CalendarSolution_List_Ul::get_rendering()</a> for more  details regarding this format.</p><p>See <a href="../CalendarSolution/_include---CalendarSolution---wordpress_shortcodes.php.html">wordpress_shortcodes.php</a> for a list of  attributes that can be used with this shortcode.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> the desired HTML</li>
				<li><span class="field">since:</span> Function available since version 3.3</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			calendar_solution_ul
		</span>
					(<span class="var-type">array</span>&nbsp;<span class="var-name">$atts</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$atts</span><span class="var-description">: the attributes used in the current shortcode call</span>			</li>
				</ul>
		
	
</div>
		</div>
	</div>
	
	<p class="notes" id="credit">
		Documentation generated on Wed, 21 Mar 2012 14:16:45 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.4</a>
	</p>
	</div></body>
</html>
Return current item: Calendar Solution