$modules->findByPrefix() method

Find modules matching the given prefix (i.e. “Inputfield”)

By default this method returns module class names matching the given prefix. To instead retrieve instantiated (ready-to-use) modules, specify boolean true for the second argument. Regardless of $load argument all returned arrays are indexed by module name.

Example

// Retrieve array of all Textformatter module names
$items = $modules->findByPrefix('Textformatter');

// Retrieve array of all Textformatter modules (ready to use)
$items = $modules->findByPrefix('Textformatter', true); 

Usage

// basic usage
$array = $modules->findByPrefix(string $prefix);

// usage with all arguments
$array = $modules->findByPrefix(string $prefix, $load = false);

Arguments

NameType(s)Description
prefixstring

Specify prefix, i.e. "Process", "Fieldtype", "Inputfield", etc.

load (optional)bool, int

Specify one of the following (all indexed by module name):

  • Boolean true to return array of instantiated modules.
  • Boolean false to return array of module names (default).
  • Integer 1 to return array of module info for each matching module.
  • Integer 2 to return array of verbose module info for each matching module.
  • Integer 3 to return array of Module or ModulePlaceholder objects (whatever current state is). Added 3.0.146.

Return value

array

Returns array of module class names or Module objects. In either case, array indexes are class names.


$modules methods and properties

API reference based on ProcessWire core version 3.0.163

Twitter updates

  • Quick weekly update covering this week's commits for the upcoming 3.0.167 ProcessWire core version— More
    18 September 2020
  • This week ProcessWire version 3.0.166 is released on the dev branch. In this post we’ll cover all that’s new relative to the previous version, 3.0.165. Plus we’ll check out the latest new versions of ProCache and FormBuilder— More
    11 September 2020
  • Weekly update – 28 August 2020 – New secure files option defined per-template: More
    28 August 2020

Latest news

  • ProcessWire Weekly #331
    In the 331st issue of ProcessWire Weekly we're going to check out the latest core and Pro module updates (ProcessWire 3.0.166, ProCache 4.0.1, and Form Builder v44), introduce the Wireframe API module, and more. Read on!
    Weekly.pw / 12 September 2020
  • ProcessWire 3.0.166 core updates and more
    This week ProcessWire version 3.0.166 is released on the dev branch. In this post we’ll cover all that’s new relative to the previous version, 3.0.165. Plus we’ll check out the latest new versions of ProCache and FormBuilder.
    Blog / 11 September 2020
  • 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