Entries
- Type
- Class
- Namespace
- craft\services
- Inherits
- craft\services\Entries » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- yii\base\Configurable (opens new window)
- 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
.
View source (opens new window)
# Public Properties
Property | Description |
---|---|
behaviors (opens new window) | yii\base\Behavior (opens new window) – List of behaviors attached to this component. |
# Public Methods
Method | Description |
---|---|
__call() (opens new window) | Calls the named method which is not a class method. |
__clone() (opens new window) | This method is called after the object is created by cloning an existing one. |
__construct() (opens new window) | Constructor. |
__get() (opens new window) | Returns the value of a component property. |
__isset() (opens new window) | Checks if a property is set, i.e. defined and not null. |
__set() (opens new window) | Sets the value of a component property. |
__unset() (opens new window) | Sets a component property to be null. |
attachBehavior() (opens new window) | Attaches a behavior to this component. |
attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
behaviors() (opens new window) | Returns a list of behaviors that this component should behave as. |
canGetProperty() (opens new window) | Returns a value indicating whether a property can be read. |
canSetProperty() (opens new window) | Returns a value indicating whether a property can be set. |
className() (opens new window) | Returns the fully qualified name of this class. |
detachBehavior() (opens new window) | Detaches a behavior from the component. |
detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
ensureBehaviors() (opens new window) | Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component. |
getBehavior() (opens new window) | Returns the named behavior object. |
getBehaviors() (opens new window) | 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() (opens new window) | Returns a value indicating whether there is any handler attached to the named event. |
hasMethod() (opens new window) | Returns a value indicating whether a method is defined. |
hasProperty() (opens new window) | Returns a value indicating whether a property is defined for this component. |
init() (opens new window) | Initializes the object. |
off() (opens new window) | Detaches an existing event handler from this component. |
on() (opens new window) | Attaches an event handler to an event. |
trigger() (opens new window) | Triggers an event. |
# getEntryById()
Returns an entry by its ID.
$entry = Craft::$app->entries->getEntryById($entryId);
View source (opens new window)
Arguments
$entryId
(integer (opens new window)) – The entry’s ID.$siteId
(integer (opens new window), string (opens new window), integer (opens new window)[], null (opens new window)) – The site(s) to fetch the entry in. Defaults to the current site.$criteria
(array (opens new window))
Returns
craft\elements\Entry, null (opens new window) – 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.
View source (opens new window)
Arguments
$handles
(string (opens new window)[])
Returns
array<string,\craft\elements\Entry>