====== FULLTEXT_SNIPPET_CREATE ======

---- dataentry event ----
Description:    Search result snippet creation
DefaultAction:  Creates a snippet using some regexp magic created from the given search string
Preventable:    yes
Added_dt:       2009-10-26
----

This event wraps the creation of a search result snippet extracted from the raw page source matching the keywords the user searched for.

===== Passed Data =====

The data is passed the following array:

<code php>
[
    'id'        => $id,
    'text'      => &$text,
    'highlight' => &$highlight,
    'snippet'   => '',
];
</code>

''text'' and ''highlight'' can be modified from within the BEFORE event. ''snippet'' will be filled with the final HTML snippet in the AFTER event or can be set on your own in the BEFORE event.


===== See also =====

  * [[codesearch>FULLTEXT_SNIPPET_CREATE|Code related to this event]] used in any DokuWiki's files, plugins and templates
  * [[devel:Action Plugins]]
  * [[devel:Events]]
  * [[xref>ft_snippet()]]