ExpressionEngine Docs

Channel Entry Model

class ExpressionEngine\Model\Channel\ChannelEntry

Properties

Required

author_id

channel_id

title

url_title

status

entry_date

Optional

entry_id Key

site_id

forum_topic_id

ip_address

status_id

versioning_enabled

view_count_one

view_count_two

view_count_three

view_count_four

allow_comments

sticky

year

month

day

expiration_date

comment_expiration_date

edit_date

recent_comment_date

comment_total

Relationships

Channel

The Channel the entry belongs to.

Author

The user that published the entry.

Status

The current status of the entry.

Categories

Selected categories the entry has.

Autosaves

If enabled, the entry autosaves.

Parents

Entries that are related to this entry.

Children

Entries that are related to this entry.

Versions

If enabled, previous versions of the entry.

Comments

Comments for the entry.

CommentSubscriptions

Comment subscriptions for the entry.

Site

The site the entry is apart of.

Methods

validateMaxEntries

validateAuthorId

validateUrlTitle

validateUniqueUrlTitle

saveTabData

saveVersion

getStructure

getDisplay

populateAllowComments

populateChannels

populateAuthors

populateCommentExpiration

populateStatus

getAuthorName

getModChannelResultsArray

hasPageURI

getPageURI

getPageTemplateID

isLivePreviewable

hasLivePreview

Events

beforeDelete

beforeInsert

beforeSave

beforeUpdate

afterDelete

afterInsert

afterSave

afterUpdate

Examples

Get an Entry by ID

$entry_id = 50;

$entry_object = ee('Model')
                ->get('ChannelEntry')
                ->filter('entry_id', $entry_id)
                ->first();

Alternatively using the Entry ID as the Primary Key:

$entry_id = 50;

$entry_object = ee('Model')
                ->get('ChannelEntry', $entry_id)
                ->first();

Create a new simple entry

$entry              = ee('Model')->make('ChannelEntry');
$entry->author_id   = ee()->session->userdata('member_id'); // Returns currently Logged-in user ID.
$entry->channel_id  = 1,
$entry->title       = 'An Awesome Title';
$entry->url_title   = ee('Format')->make('Text', 'An Awesome Title')->urlSlug()->compile(); // Returns an-awesome-title. Must be unique.
$entry->status      = ee('Model')->get('Status', 1)->first()->status; // Returns 'open';
$entry->entry_date  = ee()->localize->now; // Returns time in seconds: 1623945317

// Validate and Save.
$result = $entry->validate();

if ($result->isValid())
{
  $entry->save();
}

$entry->entry_id; // Will now return the new Entry ID.

Edit a Status

$entry_id = 3;

// Get the entry object.
$entry = ee('Model')->get('ChannelEntry', $entry_id)->first(); 

// Returns 'closed'.
$entry->status = ee('Model')->get('Status', 2)->first()->status; 

// Validate and Save.
$result = $entry->validate();

if ($result->isValid())
{
  $entry->save();
}

Get an Entry’s Children

// The parent entry.
$entry_id = 1; 

// Get the Entry's object.
$entry = ee('Model')->get('ChannelEntry', $entry_id)->first(); 

// Get the children relationship.  Returns entry objects.
$children = $entry->Children; 

// Will output array(2, 3, 4...etc);
$children_ids = $children->pluck('entry_id'); 

As One Line:

$children_ids = ee('Model')->get('ChannelEntry', 1)->first()->Children->pluck('entry_id');

Note that relationships can not be set this way.

Custom Fields

Get an Entry’s Custom Field

// Get a Channel Entry object.
$entry = ee('Model')->get('ChannelEntry', 5)->first();

// Get the field data.
$field_data = $entry->field_id_5;

// Using Variables.
$field_id = 5;
$field_data = $entry->{'field_id_'.$field_id};

Set a Custom Field

// Get a Channel Entry object.
$entry = ee('Model')->get('ChannelEntry', 5)->first();

// Set the field data.
$entry->field_id_5 = 'New Data';

// Validate and Save.
$result = $entry->validate();

if ($result->isValid())
{
  $entry->save();
}