DokuWiki

It's better when it's simple

User Tools

Site Tools


devel:event:menu_items_assembly

Differences

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

Link to this comparison view

Next revision
Previous revision
Last revision
devel:event:menu_items_assembly [2017-09-01 10:32]
andi created
devel:event:menu_items_assembly [2018-05-29 17:23]
andi
Line 8: Line 8:
 ---- ----
  
-This event is signalled by [[xref>AbstractMenu::getItems()]] (and it's children) in [[xref>inc/Menu/AbstractMenu.php]] when when the menu in question is assembled, handlers can use it to add or remove items from the menu.+This event is signalled by [[xref>AbstractMenu]]::getItems() (and it's children) in [[xref>/inc/Menu/AbstractMenu.php]] when when the menu in question is assembled, handlers can use it to add or remove items from the menu.
  
 ===== Passed Data ===== ===== Passed Data =====
Line 15: Line 15:
  
   * ''view'' defines the menu that is currently built (please refer to [[devel:Menus]] on which menus exist)   * ''view'' defines the menu that is currently built (please refer to [[devel:Menus]] on which menus exist)
-  * ''items'' contains an array of AbtractItem descendants.+  * ''items'' contains an array of [[xref>AbstractItem]] descendants. 
 + 
 +===== Example ===== 
 + 
 +An example on how to implement this event can be seen in this: 
 +  * [[https://github.com/splitbrain/dokuwiki-plugin-dw2pdf/pull/290/files|merge request for dw2pdf]]  
 +  * or [[https://github.com/Klap-in/dokuwiki-plugin-bookcreator/commit/7ab0b3409d849e39d1a4db522e1aa1727d4e6de5|commit for bookcreator]] (icon can be toggled with javascript) 
 + 
 +See also: [[devel:menus:example]]
  
 ===== Plugins handling this event ===== ===== Plugins handling this event =====
Line 21: Line 29:
 The following plugins are known to handle this event and their source code may be a good start for understanding and implementing a handler yourself. The following plugins are known to handle this event and their source code may be a good start for understanding and implementing a handler yourself.
  
-  * FIXME+  * [[plugin:Bookcreator]] 
 +  * [[plugin:dw2pdf]]
  
 ===== See also ===== ===== See also =====
  
 +  * [[codesearch>MENU_ITEMS_ASSEMBLY|Code related to this event]]
   * [[devel:Action Plugins]]   * [[devel:Action Plugins]]
   * [[devel:Events]]   * [[devel:Events]]
devel/event/menu_items_assembly.txt · Last modified: 2018-12-08 15:55 by torpedo