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 #518
    The 518th issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 13 April 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH