WireArray::implode() method

Combine all elements into a delimiter-separated string containing the given property from each item

Similar to PHP's implode() function.

Usage

// basic usage
$string = $wireArray->implode(string $delimiter);

// usage with all arguments
$string = $wireArray->implode(string $delimiter, $property = '', array $options = []);

Arguments

NameType(s)Description
delimiterstring

The delimiter to separate each item by (or the glue to tie them together). If not needed, this argument may be omitted and $property supplied first (also shifting $options to 2nd arg).

property (optional)string, callable

The property to retrieve from each item, or a function that returns the value to store. If a function/closure is provided it is given the $item (argument 1) and the $key (argument 2), and it should return the value (string) to use. If delimiter is omitted, this becomes the first argument.

options (optional)array

Optional options to modify the behavior:

  • skipEmpty (bool): Whether empty items should be skipped (default=true)
  • prepend (string): String to prepend to result. Ignored if result is blank.
  • append (string): String to append to result. Ignored if result is blank.
  • Please note that if delimiter is omitted, $options becomes the second argument.

Return value

string

See Also


WireArray methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #554
    In the 554th issue of ProcessWire Weekly we'll check out the latest core updates, introduce a couple of new third party modules, and more. Read on!
    Weekly.pw / 21 December 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer