WireMarkupRegions::find()

Locate and return all regions of markup having the given attribute

Usage

// basic usage
$array = $wireMarkupRegions->find(string $selector, string $markup);

// usage with all arguments
$array = $wireMarkupRegions->find(string $selector, string $markup, array $options = []);

Arguments

Name Type(s) Description

Name	Type(s)	Description
`$selector`	`string`	Specify one of the following: Name of an attribute that must be present, i.e. "data-region", or "attribute=value" or "tag[attribute=value]". Specify `#name` to match a specific `id='name'` attribute. Specify `.name` or `tag.name` to match a specific `class='name'` attribute (class can appear anywhere in class attribute). Specify `.name*` to match class name starting with a name prefix. Specify `<tag>` to match all of those HTML tags (i.e. `<head>`, `<body>`, `<title>`, `<footer>`, etc.)
`$markup`	`string`	HTML document markup to perform the find in.
`$options` (optional)	`array`	Optional options to modify default behavior: `single` (bool): Return just the markup from the first matching region Default:false `verbose` (bool): Specify true to return array of verbose info detailing what was found Default:false `wrap` (bool): Include wrapping markup? Default is false for id or attribute matches, and true for class matches. `max` (int): Maximum allowed regions to return Default:500 `exact` (bool): Return region markup exactly as-is? Default:false Specify true when using return values for replacement. `leftover` (bool): Specify true if you want to return a "leftover" key in return value with leftover markup. `type` (string\|int): Optional type name to return for each region.

$selector

string

Specify one of the following:

Name of an attribute that must be present, i.e. "data-region", or "attribute=value" or "tag[attribute=value]".
Specify #name to match a specific id='name' attribute.
Specify .name or tag.name to match a specific class='name' attribute (class can appear anywhere in class attribute).
Specify .name* to match class name starting with a name prefix.
Specify <tag> to match all of those HTML tags (i.e. <head>, <body>, <title>, <footer>, etc.)

$markup

string

HTML document markup to perform the find in.

$options (optional)

array

Optional options to modify default behavior:

single (bool): Return just the markup from the first matching region Default:false
verbose (bool): Specify true to return array of verbose info detailing what was found Default:false
wrap (bool): Include wrapping markup? Default is false for id or attribute matches, and true for class matches.
max (int): Maximum allowed regions to return Default:500
exact (bool): Return region markup exactly as-is? Default:false Specify true when using return values for replacement.
leftover (bool): Specify true if you want to return a "leftover" key in return value with leftover markup.
type (string|int): Optional type name to return for each region.

Return value

array

Returns one of the following:

Associative array of [ 'id' => 'markup' ] when finding specific attributes or #id attributes.
Regular array of markup regions when finding regions having a specific class attribute.
Associative array of verbose information when the verbose option is used.

Exceptions

Method can throw exceptions on error:

WireException - if given invalid $find string

WireMarkupRegions methods and properties

API reference based on ProcessWire core version 3.0.268