ProMailerSubscribers::add() method

Add a subscriber to a subscribers list

Usage

// basic usage
$proMailerSubscriber = $proMailerSubscribers->add(string $email, $list);

// usage with all arguments
$proMailerSubscriber = $proMailerSubscribers->add(string $email, $list, bool $confirmed = true, array $data = []);

Arguments

NameType(s)Description
emailstring

Email address

listProMailerList, int

List

confirmed (optional)bool

Double opt-in confirmed?

data (optional)array

Associative array of additional data (optional)

Return value

ProMailerSubscriber bool int

Returns Subscriber on success, integer ID if subscriber already exists (and confirmed), or boolean false on fail


ProMailerSubscribers methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #556
    In the 556th issue of ProcessWire Weekly we're going to share the latest core development news, highlight a new third party module, and more. Read on!
    Weekly.pw / 4 January 2025
  • 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

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer