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:57]
Tyblitz [createSideMenu]
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 71: 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 =====
core_docs/plugin_functions.1465070242.txt.gz · Last modified: 2016/06/04 19:57 by Tyblitz