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

Twitter updates

  • This post covers a few of the bigger updates in ProcessWire 3.0.154+3.0.155. This includes new live replacement of text in core and modules, a new method for creating canonical URLs, and some major upgrades to our input->urlSegment() method! More
    24 April 2020
  • A brief look at what's new in ProcessWire 3.0.154 in this forum post: More
    17 April 2020
  • This week we’ve got a few new and interesting core updates in progress, though none quite ready to release just yet. So rather than releasing version 3.0.154 today, I thought we'd instead take a brief look at what’s coming over the next few weeks… More
    3 April 2020

Latest news

  • ProcessWire Weekly #311
    In the 311th issue of ProcessWire Weekly we're going to talk a bit about the latest dev versions of ProcessWire, introduce a couple of new third party modules, and more. Read on!
    Weekly.pw / 25 April 2020
  • ProcessWire 3.0.154 and 3.0.155 core updates
    This post covers a few of the bigger updates in ProcessWire 3.0.154 and 3.0.155 on the dev branch. This includes a new function for live replacement of text in core and modules, a new method for creating canonical URLs, and some major upgrades to our $input->urlSegment() method that I think you’ll like!
    Blog / 24 April 2020
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer