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.236

Latest news

  • ProcessWire Weekly #555
    In the 555th issue of ProcessWire Weekly we're going to check out the latest core updates, introduce a new third party module that adds the ability to automatically convert email messages to pages, and more. Read on!
    Weekly.pw / 28 December 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

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer