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

NameType(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

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

Twitter updates

  • New post: With ProcessWire 3.0.130, this week we’ll take a detailed look at a few useful new API additions made in the last few weeks, along with examples of each—More
    12 April 2019
  • New post: This week ProcessWire ProMailer has been released, plus we’ve got a nice upgrade in our community support forum, and more— More
    15 March 2019
  • New post: This week we look at the latest version of ProcessWire, 3.0.127 with nearly 30 new commits resolving dozens of older issue reports and a couple useful new features— More
    1 March 2019

Latest news

  • ProcessWire Weekly #257
    In the 257th issue of ProcessWire Weekly we'll walk you through the new features in ProcessWire 3.0.130, introduce two new third party modules, and showcase the elegant new website of the QFMA. Read on!
    Weekly.pw / 13 April 2019
  • ProcessWire 3.0.130 core updates
    This week we’ll take a detailed look at a few useful new API additions made in the last few weeks, along with examples of each.
    Blog / 12 April 2019
  • Subscribe to weekly ProcessWire news

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits