Legacy Documentation
You are using the documentation for version 3.5.17. Go here for the latest version or check here for your available upgrades to the latest version.
Channel Module Extension Hooks¶
channel_entries_query_result¶
-
channel_entries_query_result($this, $query_result)¶ Modify the channel entries query result array before the parsing loop starts.
How it’s called:
$query_result = $this->extensions->call('channel_entries_query_result', $this, $query_result); if ($this->extensions->end_script === TRUE) return $this->TMPL->tagdata;
Parameters: - $this (object) – Current Channel object
- $query_result (array) – Channel entries query result array
Returns: Modified
$query_resultarrayReturn type: Array
New in version 1.6.7.
channel_entries_tagdata¶
-
channel_entries_tagdata($tagdata, $row, $this)¶ Modify the tagdata for the channel entries before anything else is parsed.
How it’s called:
$tagdata = $this->extensions->call('channel_entries_tagdata', $tagdata, $row, $this); if ($this->extensions->end_script === TRUE) return $tagdata;
Parameters: - $tagdata (string) – Channel entries tagdata
- $row (array) – Current entry data
- $this (object) – Current Channel object
Returns: Modified
$tagdataReturn type: String
New in version 1.4.0.
channel_entries_row¶
-
channel_entries_row($this, $row)¶ Modify the entry data for the channel entries before anything else is parsed.
How it’s called:
$row = $this->extensions->call('channel_entries_row', $this, $row); if ($this->extensions->end_script === TRUE) return $tagdata;
Parameters: - $this (object) – Current Channel object
- $row (array) – Current entry data
Returns: Modified
$rowReturn type: Array
New in version 1.6.7.
channel_entries_tagdata_end¶
-
function_name($tagdata, $row, $this)¶ Take the final result from an entry’s parsing and do what you will.
How it’s called:
$tagdata = $this->extensions->call('channel_entries_tagdata_end', $tagdata, $row, $this); if ($this->extensions->end_script === TRUE) return $tagdata;
Parameters: - $tagdata (string) – Channel entries tagdata
- $row (array) – Current entry data
- $this (object) – Current Channel object
Returns: Modified
$tagdataReturn type: String
New in version 1.5.0: Notes about addition
channel_module_calendar_start¶
-
channel_module_calendar_start()¶ Rewrite the displaying of the calendar tag.
How it’s called:
$edata = $this->extensions->call('channel_module_calendar_start'); if ($this->extensions->end_script === TRUE) return $edata;
Returns: Rendered calendar data Return type: String New in version 1.4.0.
channel_module_categories_start¶
-
channel_module_categories_start()¶ Rewrite the displaying of categories with the Category tag in the Channel module.
How it’s called:
return $this->extensions->call('channel_module_categories_start');
Returns: Rendered category tagdata Return type: String New in version 1.4.0.
channel_module_category_heading_start¶
-
channel_module_category_heading_start()¶ Rewrite the displaying of category headings.
How it’s called:
ee()->TMPL->tagdata = $this->extensions->call('channel_module_category_heading_start'); if ($this->extensions->end_script === TRUE) return ee()->TMPL->tagdata;
Returns: Rendered category heading tagdata Return type: String New in version 1.4.0.