Legacy Documentation
You are using the documentation for version 4.3.8. Go here for the latest version.
Wiki Module Extension Hooks¶
wiki_start¶
-
wiki_start($this)¶ Allows page template to be modified prior to article processing
How it’s called:
$this->return_data = ee()->extensions->universal_call('wiki_start', $this); if (ee()->extensions->end_script === TRUE) return;
Parameters: - $this (object) – The current Wiki class object
Returns: Modified page template (
$this->return_data)Return type: String
New in version 1.6.0.
wiki_article_start¶
-
wiki_article_start($this, $title, $query)¶ Additional processing/takeover of wiki article display.
How it’s called:
ee()->extensions->universal_call('wiki_article_start', $this, $title, $query); if (ee()->extensions->end_script === TRUE) return;
Parameters: - $this (object) – The current Wiki class object
- $title (string) – The title of the requested article
- $query (object) – The query object for the article
Return type: Void
New in version 1.6.0.
wiki_article_end¶
-
wiki_article_end($this, $query)¶ Allows takeover of wiki article display.
How it’s called:
$this->return_data = ee()->extensions->universal_call('wiki_article_end', $this, $query); if (ee()->extensions->end_script === TRUE) return;
Parameters: - $this (object) – The current Wiki class object
- $query (object) – The query object for the article
Returns: Modified article display (
$this->return_data)Return type: String
New in version 1.6.0.
wiki_special_page¶
-
wiki_special_page($this, $topic)¶ Allows complete takeover of special pages.
How it’s called:
ee()->extensions->universal_call('wiki_special_page', $this, $topic); if (ee()->extensions->end_script === TRUE) return;
Parameters: - $this (object) – The current Wiki class object
- $topic (string) – The requested topic (e.g. categories, files, etc.)
Return type: Void
New in version 1.6.0.
edit_wiki_article_end¶
-
edit_wiki_article_end($this, $query)¶ Add more things to do for wiki articles.
How it’s called:
$edata = ee()->extensions->universal_call('edit_wiki_article_end', $this, $query); if (ee()->extensions->end_script === TRUE) return;
Parameters: - $this (object) – The current Wiki class object
- $query (object) – The query object for the article
Return type: Void
New in version 1.6.0.
edit_wiki_article_form_start¶
-
edit_wiki_article_form_start($this, $title, $query)¶ Additional processing/complete takeover of the wiki article edit form.
How it’s called:
ee()->extensions->universal_call('edit_wiki_article_form_start', $this, $title, $query); if (ee()->extensions->end_script === TRUE) return;
Parameters: - $this (object) – The current Wiki class object
- $title (string) – The title of the article
- $query (object) – The query object for the requested title
Return type: Void
New in version 1.6.0.
edit_wiki_article_form_end¶
-
edit_wiki_article_form_end($this, $query)¶ Allows edit page to be modified.
How it’s called:
$this->return_data = ee()->extensions->universal_call('edit_wiki_article_form_end', $this, $query); if (ee()->extensions->end_script === TRUE) return;
Parameters: - $this (object) – The current Wiki class object
- $query (object) – The query object for the article
Returns: Modified edit page (
$this->return_data)Return type: String
New in version 1.6.0.