ExpressionEngine® 3 User Guide

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 Form Extension Hooks

channel_form_entry_form_absolute_start

channel_form_entry_form_absolute_start($channel_form_obj)

How it’s called:

ee()->extensions->call('channel_form_entry_form_absolute_start', $this);
if (ee()->extensions->end_script === TRUE) return;
Parameters:
  • $channel_form_obj (object) – Active channel form object
Return type:

Void

New in version 2.7.0.

channel_form_entry_form_tagdata_start

channel_form_entry_form_tagdata_start($tagdata, $channel_form_obj)

How it’s called:

ee()->TMPL->tagdata = ee()->extensions->call('channel_form_entry_form_tagdata_start', ee()->TMPL->tagdata, $this);
if (ee()->extensions->end_script === TRUE) return;
Parameters:
  • $tagdata (string) – Enclosed template chunk
  • $channel_form_obj (object) – Active channel form object
Return type:

String

New in version 2.7.0.

channel_form_entry_form_tagdata_end

channel_form_entry_form_tagdata_end($return_tagdata, $channel_form_obj)

How it’s called:

$return = ee()->extensions->call('channel_form_entry_form_tagdata_end', $return, $this);
if (ee()->extensions->end_script === TRUE) return;
Parameters:
  • $return_tagdata (string) – Fully processed template tagdata
  • $channel_form_obj (object) – Active channel form object
Return type:

String

New in version 2.7.0.

channel_form_submit_entry_start

channel_form_submit_entry_start($channel_form_obj)

How it’s called:

ee()->extensions->call('channel_form_submit_entry_start', $this);
if (ee()->extensions->end_script === TRUE) return;
Parameters:
  • $channel_form_obj (object) – Active channel form object
Return type:

Void

New in version 2.7.0.

channel_form_submit_entry_end

channel_form_submit_entry_end($channel_form_obj)

How it’s called:

ee()->extensions->call('channel_form_submit_entry_end', $this);
if (ee()->extensions->end_script === TRUE) return;
Parameters:
  • $channel_form_obj (object) – Active channel form object
Return type:

Void

New in version 2.7.0.