Skip to content

MoveElementEvent

Type
Class
Namespace
craft\events
Inherits
craft\events\MoveElementEvent » craft\events\ElementEvent » craft\events\CancelableEvent » yii\base\Event » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.0.0

Move element event class.

View source

Public Properties

PropertyDescription
actionstring – The type of structure action being performed (one of craft\services\Structures::ACTION_PREPEND, ACTION_APPEND, ACTION_PLACE_BEFORE, or ACTION_PLACE_AFTER).
datamixed – The data that is passed to yii\base\Component::on() when attaching an event handler.
elementcraft\base\ElementInterface – The element model associated with the event.
handledboolean – Whether the event is handled.
isNewboolean – Whether the element is brand new
isValidboolean – Whether to continue performing the action that called this event
namestring – The event name.
senderobject, null – The sender of this event.
structureIdinteger – The ID of the structure the element is being moved within.
targetElement?\craft\base\ElementInterface
targetElementIdinteger, null – The ID of the element that element is being moved in reference to, or null if element is being appended/prepended to the root of the structure.

action

Type
string
Default value
null
Since
4.5.0

The type of structure action being performed (one of craft\services\Structures::ACTION_PREPEND, ACTION_APPEND, ACTION_PLACE_BEFORE, or ACTION_PLACE_AFTER).

View source

structureId

Type
integer
Default value
null

The ID of the structure the element is being moved within.

View source

targetElement

Type
?\craft\base\ElementInterface
Default value
null

View source

targetElementId

Type
integer, null
Default value
null
Since
4.5.0

The ID of the element that element is being moved in reference to, or null if element is being appended/prepended to the root of the structure.

View source

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__construct()Constructor.
__get()Returns the value of an object property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object property.
__unset()Sets an object property to null.
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.
getTargetElement()Returns the element that element is being moved in reference to, or null if element is being appended/prepended to the root of the structure.
hasHandlers()Returns a value indicating whether there is any handler attached to the specified class-level event.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined.
init()Initializes the object.
off()Detaches an event handler from a class-level event.
offAll()Detaches all registered class-level event handlers.
on()Attaches an event handler to a class-level event.
trigger()Triggers a class-level event.

getTargetElement()

Since
4.5.0

Returns the element that element is being moved in reference to, or null if element is being appended/prepended to the root of the structure.

View source

Returns

craft\base\ElementInterface, null