ExpressionEngine Channel Entries API¶

Calling the Class
Function Reference

Calling the Class ¶

The Channel Entries class is called with the api->instantiate() function.

$this->EE->load->library('api');
$this->EE->api->instantiate('channel_entries');

Note

The API uses a Singleton pattern and does not currently support nesting of calls. Thus instantiating a new call while in the middle of a request may have unanticipated results.

This function will create a new channel entry. The data array must contain a title and data for all required fields. If the entry date or edit date are not included in the data array, current time will be used instead.

$this->EE->api_channel_entries->submit_new_entry((int) $channel_id, (mixed) $data);

returns:	(bool) Successfully Created Entry

Example Usage:

$this->EE->load->library('api');
$this->EE->api->instantiate('channel_entries');
$this->EE->api->instantiate('channel_fields');

$data = array(
        'title'         => 'Breaking News Story!',
        'entry_date'    => '1256953732',
        'edit_date'     => '1351653729',
        'field_id_6'    => 'Some data',
        'field_ft_6'    => 'none',
        'field_id_19'   => 'More data',
        'field_ft_19'   => 'xhtml'
);

$this->EE->api_channel_fields->setup_entry_settings($channel_id, $data);

if ($this->EE->api_channel_entries->submit_new_entry($channel_id, $data) === FALSE)
{
        show_error('An Error Occurred Creating the Entry');
}

See also setup_entry_settings() in the Channel Fields API.

Note

As part of the data normalization, custom data with a value of NULL is transformed to an empty string before database insertion.

Update Entry ¶

This function will update a channel entry. The data array must contain a title and data for all required fields. If the entry date or edit date are not included in the data array, current time will be used instead.

$this->EE->api_channel_entries->update_entry((int) $entry_id, (mixed) $data);

returns:	(bool) Successfully Updated Entry

Note

As part of the data normalization, custom data with a value of NULL is transformed to an empty string before database insertion.

Delete Entry ¶

This function will delete one or more entries as well as some of their related data. The data array must contain an entry id, or an array of entry ids.

$this->EE->api_channel_entries->delete_entry((mixed) $entry_ids);

returns:	(bool) Successfully Deleted Entry

Entry Exists ¶

This function checks if an entry with a given id exists.

$this->EE->api_channel_entries->entry_exists((int) $entry_id);

returns:	(bool) Entry Exists

Send Pings ¶

This function sends pings to a list of ping servers. The submit_new_entry() and update_entry() functions will automatically send pings if given ping_servers in their data array. $ping_servers should be a list of ping server ids from the exp_ping_servers database table.

$this->EE->api_channel_entries->send_pings((mixed) $ping_servers, (int) $channel_id, (int) $entry_id);

returns:	(bool) Pings Sent

Update Relationship Cache ¶

This function updates the relationship cache table. You should only need to use this function if you are manually changing relationship data, submit_new_entry() and update_entry() will automatically recompile relationship data.

$this->EE->api_channel_entries->update_related_cache((int) $entry_id);