User Tools

Site Tools


core_docs:plugin_functions

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
core_docs:plugin_functions [2016/06/04 19:48]
Tyblitz [exec_filter]
core_docs:plugin_functions [2018/02/09 08:56] (current)
backit [add_action]
Line 1: Line 1:
 ====== Plugin functions ====== ====== Plugin functions ======
-This page documents the GetSimpleCMS functions available from ''​admin/​inc/​plugin_functions.php''​.  +This page documents the GetSimpleCMS functions available from ''​admin/​inc/​plugin_functions.php''​.\\ 
-This page is currently ​work in progress.+The ones you will most commonly need as plugin/ theme developer are: 
 +<​code>​register_plugin,​ add_action, add_filter, createSideMenu,​ createNavTab,​ register_script,​ queue_script,​ register_style,​ queue_style</​code>​
  
 +The following functions are mostly used by GS internally:
 +<​code>​get_scripts_frontend,​ get_scripts_backend,​ get_styles_frontend,​ get_styles_backend,​ read_pluginsxml,​ create_pluginsxml,​ cdn_fallback,​ change_plugin</​code>​
 ===== add_action ===== ===== add_action =====
 **Signature** **Signature**
Line 11: Line 14:
  
 **Parameters** **Parameters**
-  * ''​$hook_name'',​ the name of the hook to add ''​$added_function''​ to+  * ''​$hook_name'',​ the name of the hook to add ''​$added_function''​ to. See [[plugins:​hooks_filters|core hooks list]]
   * ''​$added_function'',​ the function you want to execute at ''​$hook_name''​   * ''​$added_function'',​ the function you want to execute at ''​$hook_name''​
   * ''​$args''​ (optional), additional arguments you can supply to the ''​$added_function''​   * ''​$args''​ (optional), additional arguments you can supply to the ''​$added_function''​
Line 25: Line 28:
  
 ===== createSideMenu ===== ===== createSideMenu =====
-''''​+**Signature** 
 +<​code>​createSideMenu($id,​ $txt[, $action=null,​ $always=true])</​code>​ 
 + 
 +**Description**\\ 
 +Adds a sidebar link item to the sidebar with ''​$id'' ​as id. 
  
 **Parameters:​** **Parameters:​**
 +   ​*''​$id'',​ the id of the sidebar to output the link in
 +   ​*''​$txt'',​ the text of the sidebar item
 +   ​*''​$action''​ //​(optional)//,​ the action parameter in the link's query string. Eg, "​edit"​ will generate a link like ''​load.php?​id=myplugin&​action=edit''​
 +   ​*''​$always''​ //​(optional)//,​ set to true if the sidebar item should be loaded on every admin page with a sidebar.
 ===== createNavTab ===== ===== createNavTab =====
 **Signature** **Signature**
Line 63: Line 74:
  
 **Parameters** **Parameters**
-  * ''​$filter_name'',​ the name of the filter to hook into. Use one of the built-in filters, or one defined by a plugin.+  * ''​$filter_name'',​ the name of the filter to hook into. Use one of the [[plugins:​hooks_filters|built-in filters]], or one defined by a plugin.
   * ''​$added_function'',​ the name of a function to execute on ''​$filter_name''​.   * ''​$added_function'',​ the name of a function to execute on ''​$filter_name''​.
 ===== exec_filter ===== ===== exec_filter =====
 **Signature** **Signature**
-<​code>​exec_filter($filter_hook[, $data = array()])</​code>​+<​code>​exec_filter($filter_name[, $data = array()])</​code>​
  
 **Description**\\ **Description**\\
 Allows filtering content passed as ''​$data''​. Functions called in ''​add_function''​ will have access to the ''​$data''​ parameter.\\ ​ Allows filtering content passed as ''​$data''​. Functions called in ''​add_function''​ will have access to the ''​$data''​ parameter.\\ ​
-These functions ​*mustreturn the modified data.+These functions ​//must// return the modified data.
  
 **Parameters**\\ **Parameters**\\
-  * ''​$filter_hook'',​ the name of the filter. Other developers can add their filters by calling ''​add_filter($filter_hook, '​their_function'​);''​+  * ''​$filter_name'',​ the name of the filter. Other developers can add their filters by calling ''​add_filter($filter_name, '​their_function'​);''​
   * ''​$data''​ //​(optional)//,​ the data to be passed through the filter (an array of parameters). Defaults to null.   * ''​$data''​ //​(optional)//,​ the data to be passed through the filter (an array of parameters). Defaults to null.
 ===== change_plugin ===== ===== change_plugin =====
core_docs/plugin_functions.1465069726.txt.gz · Last modified: 2016/06/04 19:48 by Tyblitz