ExpressionEngine

2.11.9 User Guide

Retired Documentation

You are using the documentation for version 2.11.9. Go here for the latest version or check here for your available upgrades to the latest version.

Channel Entries API Extension Hooks

api_channel_entries_custom_field_query

api_channel_entries_custom_field_query($result)

Modify the custom fields query array result.

How it’s called:

$result = ee()->extensions->call('api_channel_entries_custom_field_query', $result);
if (ee()->extensions->end_script === TRUE) return;
Parameters:
  • $result (array) – Array of results from custom field query
Returns:

Modified custom fields query array result
Return type:

Array

New in version 2.5.3.

entry_submission_ready

entry_submission_ready($meta, $data, $autosave)

Additional processing after all data has been validated, just prior to insertion / update.

How it’s called:

ee()->extensions->call('entry_submission_ready', $this->meta, $this->data, $this->autosave);
Parameters:
  • $meta (array) – Entry’s metadata (channel_id, entry_date, i.e. fields for exp_channel_titles)
  • $data (array) – Entry’s field data
  • $autosave (boolean) – TRUE if the submission is a non-publishing autosave
Return type:

Void

New in version 2.0.

entry_submission_start

entry_submission_start($channel_id, $autosave)

Additional processing before an entry is submitted.

How it’s called:

$this->extensions->call('entry_submission_start', $this->channel_id, $this->autosave);
Parameters:
  • $channel_id (int) – Channel ID of submitted entry
  • $autosave (boolean) – TRUE if the submission is a non-publishing autosave
Return type:

Void

New in version 2.0.

entry_submission_end

entry_submission_end($entry_id, $meta, $data)

Do more processing after an entry is submitted.

How it’s called:

$this->extensions->call('entry_submission_end', $this->entry_id, $this->meta, $this->data);
Parameters:
  • $entry_id (int) – ID of the entry being submitted
  • $meta (array) – Entry’s metadata (channel_id, entry_date, i.e. fields for exp_channel_titles)
Return type:

Void

New in version 2.0.

delete_entries_end

delete_entries_end()

Executed after the entry deletion routine complete, allowing additional processing.

How it’s called:

$this->extensions->call('delete_entries_end');
if ($this->extensions->end_script === TRUE) return;
Return type:Void

New in version 1.4.0.

delete_entries_loop

delete_entries_loop($val, $channel_id)

Executed in the loop that deletes each entry, after deletion, prior to stat recounts.

How it’s called:

$edata = $this->extensions->call('delete_entries_loop', $val, $channel_id);
if ($this->extensions->end_script === TRUE) return;
Parameters:
  • $val (int) – ID of the entry being deleted
  • $channel_id (int) – Channel ID of the entry being deleted
Return type:

Void

New in version 1.4.1.