The moveToSiblingPosition() method moves the target node to a specific position within its sibling nodes, based on the given offset.

Description

public AbstractNode::moveToSiblingPosition(int $index): ?NodeInterface

Parameters

index

The zero-based index representing the new position of the target node within its siblings.

Return Value

Returns a NodeInterface representing the node that was previously at the specified position, or null if the operation failed.

Exceptions

HIERARCHY_REQUEST_ERR

Thrown if the current node cannot be moved to the specified position due to hierarchy constraints.