HookEvent::arguments() method

Retrieve or set a hooked function argument

Example

// Retrieve first argument by index (0=first)
$page = $event->arguments(0);

// Retrieve array of all arguments
$arguments = $event->arguments();

// Retrieve argument by name
$page = $event->arguments('page');

// Set first argument by index
$event->arguments(0, $page);

// Set first argument by name
$event->arguments('page', $page); 

Usage

// basic usage
$array = $event->arguments();

// usage with all arguments
$array = $event->arguments(int $n = null, mixed $value = null);

Arguments

NameType(s)Description
n (optional)int

Zero based number of the argument you want to retrieve, where 0 is the first. May also be a string containing the argument name. Omit to return array of all arguments.

value (optional)mixed

Value that you want to set to this argument, or omit to only return the argument.

Return value

array null mixed


$event methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #549
    In the 549th issue of ProcessWire Weekly we’re going to check out the latest core updates, highlight one older yet still very relevant third party module, and more. Read on!
    Weekly.pw / 17 November 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer