Skip to content

Announcements

Type
Class
Namespace
craft\services
Inherits
craft\services\Announcements » yii\base\Component » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.7.0

Announcements service.

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

View source

Public Properties

PropertyDescription
behaviorsyii\base\Behavior – List of behaviors attached to this component.

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.
get()Returns any announcements for the logged-in user.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
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.
markAsRead()Marks the user’s announcements as read.
off()Detaches an existing event handler from this component.
on()Attaches an event handler to an event.
push()Pushes a new announcement out to all control panel users.
trigger()Triggers an event.

get()

Since
3.7.0

Returns any announcements for the logged-in user.

View source

Returns

array

markAsRead()

Marks the user’s announcements as read.

View source

Arguments

Returns

void

push()

Pushes a new announcement out to all control panel users.

View source

Arguments

  • $heading (string, callable) – The announcement heading. Set to a callable if the heading text should be translated with Craft::t().
  • $body (string, callable) – The announcement body. Set to a callable if the heading text should be translated with Craft::t().
  • $pluginHandle (string, null) – The plugin handle, if this announcement belongs to a plugin

Returns

void