Skip to content

Content

Type
Class
Namespace
craft\services
Inherits
craft\services\Content » yii\base\Component » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.0.0

Content service.

An instance of the service is available via Craft::$app->content.

View source

Public Properties

PropertyDescription
behaviorsyii\base\Behavior – List of behaviors attached to this component.
contentTablestring
dbcraft\db\Connection, array, string – The database connection to use
fieldColumnPrefixstring
fieldContextstring

contentTable

Type
string
Default value
\craft\db\Table::CONTENT

View source

db

Type
craft\db\Connection, array, string
Default value
'db'
Since
3.5.6

The database connection to use

View source

fieldColumnPrefix

Type
string
Default value
'field_'

View source

fieldContext

Type
string
Default value
'global'

View source

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__clone()This method is called after the object is created by cloning an existing one.
__construct()Constructor.
__get()Returns the value of a component property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets the value of a component property.
__unset()Sets a component property to be null.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
behaviors()Returns a list of behaviors that this component should behave as.
canGetProperty()Returns a value indicating whether a property can be read.
canSetProperty()Returns a value indicating whether a property can be set.
className()Returns the fully qualified name of this class.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
ensureBehaviors()Makes sure that the behaviors declared in behaviors() are attached to this component.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getContentRow()Returns the content row for a given element, with field column prefixes removed from the keys.
hasEventHandlers()Returns a value indicating whether there is any handler attached to the named event.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined for this component.
init()Initializes the object.
off()Detaches an existing event handler from this component.
on()Attaches an event handler to an event.
populateElementContent()Populates a given element with its custom field values.
saveContent()Saves an element's content.
trigger()Triggers an event.

getContentRow()

DEPRECATED

Deprecated in 3.7.0

Returns the content row for a given element, with field column prefixes removed from the keys.

View source

Arguments

Returns

array, null – The element's content row values, or null if the row could not be found

init()

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

View source

populateElementContent()

DEPRECATED

Deprecated in 3.7.0

Populates a given element with its custom field values.

View source

Arguments

saveContent()

Saves an element's content.

View source

Arguments

Returns

boolean – Whether the content was saved successfully. If it wasn't, any validation errors will be saved on the element and its content model.

Throws

Events

EVENT_AFTER_SAVE_CONTENT

Type
craft\events\ElementContentEvent

The event that is triggered after an element's content is saved.


EVENT_BEFORE_SAVE_CONTENT

Type
craft\events\ElementContentEvent

The event that is triggered before an element's content is saved.