Entries ​
- Type
- Class
- Namespace
- craft\services
- Inherits
- craft\services\Entries » yii\base\Component » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Since
- 3.0.0
The Entries service provides APIs for managing entries in Craft.
An instance of the service is available via Craft::$app->entries
.
Public Properties ​
Property | Description |
---|---|
behaviors | yii\base\Behavior – List of behaviors attached to this component. |
Public Methods ​
Method | Description |
---|---|
__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. |
getEntryById() | Returns an entry by its ID. |
getSingleEntriesByHandle() | Returns an array of Single section entries which match a given list of section handles. |
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. |
trigger() | Triggers an event. |
getEntryById()
​
Returns an entry by its ID.
php
$entry = Craft::$app->entries->getEntryById($entryId);
Arguments ​
$entryId
(integer) – The entry’s ID.$siteId
(integer, string, integer[], null) – The site(s) to fetch the entry in. Defaults to the current site.$criteria
(array)
Returns ​
craft\elements\Entry, null – The entry with the given ID, or null
if an entry could not be found.
getSingleEntriesByHandle()
​
- Since
- 4.4.0
Returns an array of Single section entries which match a given list of section handles.
Arguments ​
$handles
(string[])
Returns ​
array<string,\craft\elements\Entry>