devel:event:indexer_page_add
Table of Contents
INDEXER_PAGE_ADD
- Description:
- manipulate the full text indexing process
- DefaultAction:
- add the page data to the index
- Preventable:
- yes
- Added:
- 2007-02-27
This event is signalled by idx_addPage() in inc/indexer.php before a page is added to the index. Before the 2011-05-25 “Rincewind” release this event was signalled by idx_getPageWords() in inc/indexer.php before a page was added to the fulltext index.
Passed Data
Since 2011-03-06 (included in the 2011-05-25 “Rincewind” release) the data structure is:
$data['page']
– the page id$data['body']
– empty, can be filled by additional content to index by your plugin$data['metadata']
– the metadata that shall be indexed. This is an array where the keys are the metadata indexes and the value a string or an array of strings with the values.title
andrelation_references
will already be set.
All data you put into $data['body'] will be prepended to the real page content. If you don't want the page content to be added call preventDefault().
The old data structure (used before the 2011-05-25 “Rincewind” release) was:
- $data[0] – the page id
- $data[1] – empty, can be filled by additional content to index by your plugin (used in the same way as the new 'body')
See also
- Code related to this event used in any DokuWiki's files, plugins and templates
devel/event/indexer_page_add.txt · Last modified: by torpedo