ProMailerSubscribers::find()

Get current pagination (limit=100) of subscribers for given list

Includes both confirmed and non-confirmed subscribers

Usage

// basic usage
$items = $proMailerSubscribers->find();

// usage with all arguments
$items = $proMailerSubscribers->find(array $options = []);

Arguments

NameType(s)Description
$options (optional)array
  • list (ProMailerList|int): List to limit find to
  • sort (string): What to sort by Default:'-created'
  • email (string): Find subscriber email that contains this text
  • custom (string): Find subscriber that matches string in custom data Note that string in 'custom' containing selector like 'field=value' get converted to 'filters' option.
  • partial (bool): Perform a partial match rather than exact match (for 'custom' or 'email')? Default:true
  • confirmed (bool|int): Return only confirmed subscribers? Or -1 for only non-confirmed Default:false
  • id (int): Count only subscribers greater than or equal to this subscriber ID Default:0
  • limit (int): Limit to this many subscribers per pagination Default:100
  • count (bool): Return a count rather than subscribers? Default:false
  • delete (bool): Delete all found subscribers rather than return them? Default:false
  • filters (array): Find subscribers that match these [ key=value ] filter(s) in custom data. To perform exact match, specify [ 'field' => '=value' ] or [ 'field' => 'value' ] (operator optional). To perform partial match, specify [ 'field' => '%=value' ]. To perform NOT match, specify [ 'field' => '!=value' ] for exact, or [ 'field' => '!%=value' ] for partial.

Return value

ProMailerSubscribersArray int

Returns array of subscribers or integer if 'count' or 'delete' option specified

ProMailerSubscribers methods and properties

API reference based on ProcessWire core version 3.0.255