developwithwp/omg-forms-constant-contact

An OMG Forms addon, which adds support for Constant Contact forms.

v0.6.0 2018-04-16 20:08 UTC

Requires

• constantcontact/constantcontact: dev-master
• developwithwp/omg-forms: v0.10.*

GPL-2.0+

README

A WordPress Forms Solution built specifically for Developers. This addon will send all form submissions to Constant Contact.

Installation

OMG Forms can be installed via composer.

$ composer require developwithwp/omg-forms-constant-contact

Once you have installed this package you will need to call Composer's autoloader if your project is not already.

if ( file_exists( get_template_directory() . '/vendor/autoload.php' ) ) {
    require( 'vendor/autoload.php' );
}

Usage

In order for this Addon to function properly, you must have a valid Constant Contact API Key as well as an access token. Both of these can be obtained from Mashery.

You are now ready to create your first form. OMG Forms comes with a helper method for creating new forms \OMGForms\Core\register_form().

This function expects an array of arguments similar to how register_post_type expects an array of arguments.

To start lets define a very simple form.

$args = [
		'name'              =>  'my-form-name',
		'redirect'          =>  false,
		'email'             =>  false,
		'form_type'         =>  'constant-contact',
		'success_message'   =>  'Thank you!',
		'list_id'           =>  '1233',
		'fields' => [
			[
				'slug'      =>   'first_name',
				'label'     =>   'First Name',
				'type'      =>   'text',
				'required'  =>   true
			],
			[
				'slug'      =>   'last_name',
				'label'     =>   'Last Name',
				'type'      =>   'text',
				'required'  =>   true
			],
			[
				'slug'      =>  'email-address',
				'label'     =>  'Email',
				'type'      =>  'email',
				'required'  =>   true
			]
		]
	];

As you can see the form allows for a lot of configuration at both the form and the field level.

Once you have defined a form, you can render it by calling display_form.

echo \OMGForms\Core\display_form( 'my-form-name' );

Notes

For the Constant Contact addon to work you will need to ensure you provide a few key settings when registering your form.

1. form-type must be set to constant-contact
2. Each form must have a list_id set. This is so that we can add contacts to the correct list.
3. First and Last Name fields should have a slug of first_name and last_name.
4. Must provide an email field with a slug of email-address.

For more information about OMG Forms in general, please check out the base repo.