You are here: start » call_plugins

Call Plugins

FIXME Merge with cmsimple_scripting

Some plugins work right away after successful installation, e.g. the plugin ge_canonical_XH. As soon as the plugin is uploaded into the CMSimple plugins folder, it will create the so called “canonical link” automatically in the head area of the source code of all pages.

Usually however plugins need to be called via certain parameters on the place where they are supposed to function. This place can be in the content of a page or anywhere in the template.

Important Notice

Many plugin developers give examples of function calls in their help files. If however you copy these calls and insert them into the text of a page, you may copy hidden formatting.

In this case the plugin usually will not work. Therefore:

!!! ALWAYS enter the function calls for plugins in source code view !!!

Further possibilities:

  • Save the function call in a .txt-file and copy it from that file into your CMSimple_XH page or simple retype the function call.

Function Calls inside the Contents of a Page

The function call of a plugin can be done via CMSimple Scripting or via direct function call.

Via CMSimple Scripting:

While calling the Plugins via CMSimple scripting the output of the plugin will be added to the end of the page contents. No matter where the plugin is called in the page, its output will always be added after the page contents.

Plugin calls via CMSimple Scripting are entered like this:

#CMSimple $output.= function(parameter);#

Usually the help file gives further details on how exactly to call the plugin functions. With most plugins the help file is directly accessible via the plugin menu and will open in a new tab or window.

⇑ top

Direct Function Calls:

New in CMsimple_XH is the possibility to call a plugin function directly within the page content. With this method the output of the plugin will appear in the place where it is called in the page. Moreover several function calls per page are possible.

With most plugins it works but not with all of them. If it's not documented in the plugin's user manual, just try it out.

{{{PLUGIN:function(parameter);}}}

Usually the help file gives further details on how exactly to call the plugin functions. With most plugins the help file is directly accessible via the plugin menu and will open in a new tab or window.

⇑ top

Function Calls in a Template

Plugin functions can also be called from the template. In this way their output is present on every CMSimple_XH page. Practical examples are login forms of the plugins memberpages and register.

<?php echo function(parameter);?>

Usually the help file gives further details on how exactly to call the plugin functions. With most plugins the help file is directly accessible via the plugin menu and will open in a new tab or window.

⇑ top

 
You are here: start » call_plugins
Except where otherwise noted, content on this wiki is licensed under the following license: GNU Free Documentation License 1.3
Valid XHTML 1.0 Valid CSS Driven by DokuWiki