WireData::and() method

Take the current item and append the given item(s), returning a new WireArray

This is for syntactic convenience in fluent interfaces.

Example

if($page->and($page->parents)->has("featured=1")) { 
   // page or one of its parents has a featured property with value of 1
}

Usage

// basic usage
$items = $wireData->and();

// usage with all arguments
$items = $wireData->and($items = null);

Arguments

Name Type(s) Description

Name	Type(s)	Description
`items` (optional)	WireArray, WireData, string, null	May be any of the following: `WireData` object (or derivative) `WireArray` object (or derivative) Name of any property from this object that returns one of the above. Omit argument to simply return this object in a WireArray

items (optional)

WireArray, WireData, string, null

May be any of the following:

WireData object (or derivative)
WireArray object (or derivative)
Name of any property from this object that returns one of the above.
Omit argument to simply return this object in a WireArray

Return value

WireArray

Returns a WireArray of this object and the one(s) given.

Exceptions

Method can throw exceptions on error:

WireException - If invalid argument supplied.

Hooking WireData::and(…)

You can add your own hook events that are executed either before or after the WireData::and(…) method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.

Hooking before

The 'before' hooks are called immediately before each WireData::and(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('WireData::and', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $WireData = $event->object;

  // Get values of arguments sent to hook (and optionally modify them)
  $items = $event->arguments(0);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $items);
});

Hooking after

The 'after' hooks are called immediately after each WireData::and(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('WireData::and', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $WireData = $event->object;

  // An 'after' hook can retrieve and/or modify the return value
  $return = $event->return;

  // Get values of arguments sent to hook (if needed)
  $items = $event->arguments(0);

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

WireData methods and properties

API reference based on ProcessWire core version 3.0.248