HookEvent::argumentsByName() method

Returns an array of all arguments indexed by name, or the value of a single specified argument

Note: $event->arguments('name') can also be used as a shorter synonym for $event->argumentsByName('name').

Example

// Get an array of all arguments indexed by name
$arguments = $event->argumentsByName();

// Get a specific argument by name
$page = $event->argumentsByName('page'); 

Usage

// basic usage
$mixed = $event->argumentsByName();

// usage with all arguments
$mixed = $event->argumentsByName(string $n = '');

Arguments

NameType(s)Description
n (optional)string

Optional name of argument value to return. If not specified, array of all argument values returned.

Return value

mixed array

Depending on whether you specify $n


$event methods and properties

API reference based on ProcessWire core version 3.0.248

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits