Campaign Monitor Feed Meta

Introduction

The Feed Meta object meta for the Campaign Monitor Add-On is an associative array containing the properties which determine how the add-on should process the form submission.

$feed['meta'] = array(
    'feedName'                                => 'Your Feed Name',
    'listFields_email'                        => '2',
    'listFields_fullname'                     => '1',
    'resubscribe'                             => false,
    'feed_condition_conditional_logic'        => true,
    'feed_condition_conditional_logic_object' => array(
        'conditionalLogic' => array(),
    ),
);

Usage

We recommend accessing the $feed meta using the rgar() or rgars() functions, e.g.:

$conditional_logic_enabled = rgars( $feed, 'meta/feedCondition' );

if ( $conditional_logic_enabled ) {
    // Conditional logic is enabled for this feed.
    $logic_rules = rgars( $feed, 'meta/feed_condition_conditional_logic_object/conditionalLogic/rules' );
    foreach ( $logic_rules as $rule ) {
        // Process each conditional logic rule.
        $field_id  = rgar( $rule, 'fieldId' );
        $operator  = rgar( $rule, 'operator' );
        $value     = rgar( $rule, 'value' );
        // Example: Use $field_id, $operator, and $value in your logic.
    }
}

Properties

  • feedName string

    The feed name which appears on the add-ons feeds tab.

  • client string

    The Campaign Monitor client ID the contacts will be added to.

  • contactList string

    The Campaign Monitor list ID the contacts will be added to.

  • listFields_email string

    The ID of the field containing the user’s email.

  • listFields_fullname string

    The ID of the field containing the user’s full name.

  • listFields_{custom_field_name} string

    The ID of the field containing the value for the custom field.

    There would be properties for any custom fields configured for your list, they all begin listFields_ and then end with the custom field name (no spaces), e.g. listFields_ipaddress.

  • resubscribe boolean

    Should the subscriber be re-added to the active list if they are in an inactive state or have previously been unsubscribed? Default is false.

  • feed_condition_conditional_logic boolean

    Is the feed condition (conditional logic) setting enabled. Default is false.

  • feed_condition_conditional_logic_object array

    An associative array containing the conditional logic rules. See the Conditional Logic Object for more details.