ProcessPageEdit::getSubmitActions() method

Get actions for submit button(s)

Should return array where each item in the array is itself an array like this:

Array returned by this method is indexed by the 'value', though this is not required for hooks.

Available since version 3.0.142.

Example

[ 
  'value' => 'value of action, i.e. view, edit, add, etc.',
  'icon' => 'icon name excluding the “fa-” part',
  'label' => 'text label where %s is replaced with submit button label',
  'class' => 'optional class attribute',
]

Usage

$array = $processPageEdit->getSubmitActions();

Return value

array

Exceptions

Method can throw exceptions on error:

WireException

Hooking ProcessPageEdit::getSubmitActions()

You can add your own hook events that are executed either before or after the ProcessPageEdit::getSubmitActions() method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.

Hooking before

The 'before' hooks are called immediately before each ProcessPageEdit::getSubmitActions() method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('ProcessPageEdit::getSubmitActions', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $ProcessPageEdit = $event->object;

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
});

Hooking after

The 'after' hooks are called immediately after each ProcessPageEdit::getSubmitActions() method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('ProcessPageEdit::getSubmitActions', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $ProcessPageEdit = $event->object;

  // An 'after' hook can retrieve and/or modify the return value
  $return = $event->return;

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

ProcessPageEdit methods and properties

API reference based on ProcessWire core version 3.0.236