Developer's Guide for Creating Plugins for the Breeze Website Builder™


Plugins are stored as records in the plugins table and are deployed when selected during the page creation process. This includes code to be inserted into the page in the form of server-side code (PHP), and client-side code (HTML, JavaScript, inline CSS, JQuery, etc.), in the head or the body of the document. The server-side code is injected right into the page file at the time of its creation. The client-side code is stored as records either in the page_data table or the head table, and is called out to be sent to the client when the page file is processed. Also included in a plugin record is default style sheet SQL that is deployed in tables with the same structure as the site_classes and site_css tables. These styles can be modified using the Breeze Website Builder's™ built-in style editor. You will be supplying a style sheet name and description that will be added to the style-sheet drop-down list. And last, you can also specify a button name and a path to a backend console for your plugin. These buttons can appear under any of the main categories on the main menu, or on any or all of the HTML/code editors. You can store SQL in the plugin record to deploy a control table for your plugin as well. The only thing you won't be storing in the plugin record is any backend-console modules that you created. Instead, you can just FTP your modules to a folder of your choice. (You can specify the path to your module in the button link field.)

You will want to download the Plugin SDK here. It has a tool for creating the plugin record as well editors for building your console modules, and a utility for packaging your plugin as a zip file when you are all done. This plugin SDK is actually a plugin into itself. To install it, just install it as a plugin into your intallation of the Breeze Webiset Builder™. You will see the new Plugin SDK button under SITE MANAGEMENT.

For more information or plugin types see types of plugins.