bookmark_borderMailChimp Feed Meta

Introduction

The Feed Object meta for the MailChimp 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',
	'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/feed_condition_conditional_logic' );

Properties

  • feedName string

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

  • mailchimpList string

    The API List ID for the MailChimp list this feed will subscribe the user to when processed.

  • mappedFields_EMAIL string

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

  • mappedFields_FNAME string

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

  • mappedFields_FNAME string

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

  • mappedFields_{tag} string

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

    There would also be properties for any other List fields and *|MERGE|* tags configured for your list, they all begin mappedFields_ and then end with the tag e.g. mappedFields_MMERGE3

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

Groups

If the MailChimp List has any groups configured, the following properties will be added for each group. {GROUPID} is a 13 character unique ID generated by the add-on to identify the group.

  • mc_group_{GROUPID}_enabled boolean

    Should the user be added to the group.

  • mc_group_{GROUPID}_decision string

    Should the user always be added to the group or only if the configured condition is met. Possible values: if or always

  • mc_group_{GROUPID}_field_id string

    The ID of the field containing the value which should be compared against mc_group_{GROUPID}_value.

  • mc_group_{GROUPID}_operator string

    Operator to be used when evaluating this rule. Possible values: is, isnot, >, <, contains, starts_with, or ends_with

  • mc_group_{GROUPID}_value string

    The value required for the user to be added to the group.