Using Module Plugins | SiteApex Support
Developer Tools
Using Module Plugins

Several of our modules have template plugins that pull data from the main module. These plugins need to be placed within the html code of the template.

Mini News
Pulls content from News Manager

<?php $miniFeedID = 1; include("./News/miniNews.inc.php"); ?>

Place this code into your html template to display intro's to your news stories. ID number should be the ID number of the feed (roll over the News Feed [edit] link and check the status bar at the bottom of your browser to confirm Feed ID number.

Configure the options for this plugin in Admin > Modules > News Manager > Edit News Feed (Mini News tab).

Get Custom CSS >

Featured Article
Pulls content from News Manager

<?php $oneArticleFeed = 1; include("./News/oneArticlePlugin.inc.php"); ?>

Place this code into your html template to display an intro to the most recent or Featured article. This plugin includes a featured photo by default and can be set to select a random feature, making it ideal for testimonials. ID number should be the ID number of the feed.

Configure the options for this plugin in Admin > Modules > News Manager > Edit News Feed (One Article tab).

Get Custom CSS >



Mini Calendar
Pulls events from any one Calendar

<?php $calendarID = 1; include("./Calendar/miniCalendar.inc.php"); ?>

Place this code into your html template to display upcoming event summary information off your calendar. ID number in the code should be the ID number of the calendar.

Get Custom CSS >

Coming Events
Pulls events from any one Calendar

<?php $calendarID = 1; include("./Calendar/comingEvents.inc.php"); ?>

Place this code into your html template to display upcoming event summary information off your calendar. ID number in the code should be the ID number of the calendar (Click on the Event Title and get a pop-up of the event details).

The Coming Events Title and the Number of Days before the event date to start displaying events is controlled in Admin > Modules > Calendar Module > Edit Calendar.

Optional Variables (defaults are shown):
//For the display of the date add (before the include statement):
$comingEventsDateFormat = "l M. J - Y"

//To show all coming eventsadd (before the include statement):
$showAllComingEvents = false;

Get Custom CSS >

Mini Blog
Pulls posts from any Blog

<?php
$miniBlogID = 1;
$miniBlogCatID = 3; // optional
$miniBlogAdditionalTitle = 'Solutions'; // optional
include("./BLOG/miniBlog.inc.php");
?>


Place this code into your html template to display the most recent post. ID number in the code should be the ID number of the Blog (and blog category, if applicable).

Get Custom CSS >

FormBuilder Plugin
Pulls content from a Form

<?php $formPluginID = 1; $formPluginPage = "pagename.php"; include("./FormBuilder/formBuilderPlugin.inc.php"); ?>

Place this code into your html template to display form fields from a form.

The variables that are required are the following:
$formPluginID - this is the ID number of the form. Ex. $formPluginID = 1;
$formPluginPage - this is the page name that the form will post to. Ex. $formPluginPage = "newslettersignups1.php"; **This page must have a page type of "Form Builder"**

Get Custom CSS >>

Optional Variables
There are several optional variables that can be used to customize the look of the plugin.

$formPluginLabelOrientation = "beside";
Used to specify where the field label will show up
Options are:
  • beside - Labels will appear beside the input field in their own table cell.
  • ontop - Labels will appear above the input field followed by a <br> tag.
  • inside - Labels will appear within the input field and will dissappear when the input field has focus (Some input fields that do not support this feature will default to label on top if this option is specified)
*Default is beside

$formPluginTextBoxSize = 20;
This is used to specify the size of the text boxes that will appear on the form;
*Default is 20

$formPluginTextAreaCols = 10;
This controls the width of the text area field type
*Default is 10

$formPluginTextAreaRows = 5;
This controls the height of the text area field type
*Default is 5

$formPluginRequiredMarkerDisplay = "separate";
This is used to specify whether the required * marker will show up in its own table cell, or inline with the Label separated by a non-line breaking space.
If the Label orientation is set to inside, the required * marker will appear outside of the input field.
Options are:
  • separate - the required * marker will show up in its own table cell
  • inline - the required * marker will display inline with the label. Styles are applied through a span tag.
*Default is separate

$formPluginSubmitType = "button";
This is used to specify if the submit control is a image or a button
Options are:
  • button - this will display a button
  • image - this will display a image (The $formPluginSubmitImageURL variable becomes required if you choose this option)
*Default is button

$formPluginSubmitImageURL = "./images/submit.jpg";
This is used to set the source for the image submit type. The image reference is relative.
This is required if SubmitType is set to image.

$formPluginSubmitButtonText = "Submit";
This is used to change the label on the submit button.
*Default is Submit

$formPluginShowFormName = "no";
This is used to enable/disable showing the Form Name.
Options: yes, no
*Default is no

$formPluginShowFormIntro = "no";
This is used to enable/disable showing the form intro (editor field in site apex)
Options: yes, no
*Default is no

Poll Plug-in
Pulls a question from any one Questionnaire

1. Create questionnaire in SiteApex and ONLY use a SINGLE radio button question.
- Multiple questions not supported.
- Only radio type questions supported.

2. Place plugin code into the template where you want the plugin to appear. The pollID is the Questionnaire ID.
-Sample code (the spelling of Questionaire is not a typo in the sample code):

<?php $pollID = 1; include("./Questionaire/poll.inc.php"); ?>

Get Custom CSS >

3. There is a config option for the Poll Plugin named 'PollPluginTitle' which will set the Title of the poll on your site. Your account rep or tech support can help with this.
- Title is per site only. There is no support for per plugin at this time.