bookmark_borderBatchbook Feed Meta

Introduction

The Feed Object meta for the Batchbook add-on is an associative array containing the properties which determine how the add-on should process the form submission.

$feed['meta'] = array(
	'feed_name'                               => 'Batchbook Feed 1',
	'person_standard_fields_first_name'       => '2',
	'person_custom_fields'                    => array(),
	'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

  • feed_name string

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

  • person_standard_fields_first_name string

    The ID of the form field containing the contact’s first name.

  • person_standard_fields_last_name string

    The ID of the form field containing the contact’s last name.

  • person_standard_fields_email_address string

    The ID of the form field containing the contact’s email.

  • person_custom_fields array

    A multidimensional array containing the Batchbook custom fields. See Custom Field Properties

  • person_tags string

    A comma separated list of tags to be assigned to the contact. Merge tags supported.

  • person_about string

    The content to be assigned to the contact’s about field. Merge tags supported.

  • person_update_enable boolean

    Should an existing contact be updated if found? Default is false.

  • person_update_action string

    The update action. Should the contact details be replaced or appended. Job title and company will be replaced whether replace or append is chosen. Possible values: replace or append

  • person_mark_as_champion boolean

    Should the person be marked as a champion. 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.

Custom Field Properties

array(
    'key'   => 'title',
    'value' => '3',
)

Each custom field is an associative array containing the following properties:

  • key string

    The Batchbook custom field key.

    The default keys are: title, company, email_work, email_home, email_other, phone_main, phone_work, phone_mobile, phone_home, phone_fax, phone_other, address_main, address_work, address_home, address_billing, address_shipping, address_other, website_main, website_work, website_home, and website_other.

    Other custom fields all begin custom_field_ and then end with the Batchbook set ID and the Batchbook field ID e.g. custom_field_1_7

  • value string

    The ID of the form field or entry meta item containing the value for this custom field.