Announcements
- Type
- Class
- Namespace
- craft\services
- Inherits
- craft\services\Announcements » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- yii\base\Configurable (opens new window)
- Since
- 3.7.0
Announcements service.
An instance of the service is available via Craft::$app->announcements.
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. |
| get() | Returns any announcements for the logged-in user. |
| getBehavior() (opens new window) | Returns the named behavior object. |
| getBehaviors() (opens new window) | Returns all behaviors attached to this component. |
| 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. |
| markAsRead() | Marks the user’s announcements as read. |
| off() (opens new window) | Detaches an existing event handler from this component. |
| on() (opens new window) | Attaches an event handler to an event. |
| push() | Pushes a new announcement out to all control panel users. |
| trigger() (opens new window) | Triggers an event. |
# get()
- Since
- 3.7.0
Returns any announcements for the logged-in user.
View source (opens new window)
Returns
# markAsRead()
Marks the user’s announcements as read.
View source (opens new window)
Arguments
$ids(integer (opens new window)[])
Returns
void
# push()
Pushes a new announcement out to all control panel users.
View source (opens new window)
Arguments
$heading(string (opens new window), callable (opens new window)) – The announcement heading. Set to a callable if the heading text should be translated withCraft::t().$body(string (opens new window), callable (opens new window)) – The announcement body. Set to a callable if the heading text should be translated withCraft::t().$pluginHandle(string (opens new window), null (opens new window)) – The plugin handle, if this announcement belongs to a plugin
Returns
void