version = '1.3.6'; $this->name = 'Constant Contact'; $this->slug = 'constant-contact'; $this->priority = 14; $this->icon = WPFORMS_PLUGIN_URL . 'assets/images/icon-provider-constant-contact.png'; if ( is_admin() ) { // Admin notice requesting connecting. $this->connect_request(); add_action( 'wpforms_admin_notice_dismiss_ajax', [ $this, 'connect_dismiss' ] ); add_action( 'wpforms_admin_page', [ $this, 'learn_more_page' ] ); add_filter( "wpforms_providers_provider_settings_formbuilder_display_content_default_screen_{$this->slug}", [ $this, 'builder_settings_default_content' ] ); // Provide option to override sign up link. $sign_up = get_option( 'wpforms_constant_contact_signup', false ); if ( $sign_up ) { $this->sign_up = esc_html( $sign_up ); } } } /** * Process and submit entry to provider. * * @since 1.3.6 * * @param array $fields List of fields with their data and settings. * @param array $entry Submitted entry values. * @param array $form_data Form data and settings. * @param int $entry_id Saved entry ID. * * @return void */ public function process_entry( $fields, $entry, $form_data, $entry_id = 0 ) { // Only run if this form has a connections for this provider. if ( empty( $form_data['providers'][ $this->slug ] ) ) { return; } /* * Fire for each connection. */ foreach ( $form_data['providers'][ $this->slug ] as $connection ) : // Before proceeding make sure required fields are configured. if ( empty( $connection['fields']['email'] ) ) { continue; } // Setup basic data. $list_id = $connection['list_id']; $account_id = $connection['account_id']; $email_data = explode( '.', $connection['fields']['email'] ); $email_id = $email_data[0]; $email = $fields[ $email_id ]['value']; $this->api_connect( $account_id ); // Email is required and Access token are required. if ( empty( $email ) || empty( $this->access_token ) ) { continue; } // Check for conditionals. $pass = $this->process_conditionals( $fields, $entry, $form_data, $connection ); if ( ! $pass ) { wpforms_log( esc_html__( 'Constant Contact Subscription stopped by conditional logic', 'wpforms-lite' ), $fields, array( 'type' => array( 'provider', 'conditional_logic' ), 'parent' => $entry_id, 'form_id' => $form_data['id'], ) ); continue; } // Check to see if the lead already exists in Constant Contact. $response = wp_remote_get( 'https://api.constantcontact.com/v2/contacts?api_key=' . $this->api_key . '&access_token=' . $this->access_token . '&email=' . $email ); $contact = json_decode( wp_remote_retrieve_body( $response ), true ); // Return early if there was a problem. if ( isset( $contact['error_key'] ) ) { wpforms_log( esc_html__( 'Constant Contact API Error', 'wpforms-lite' ), $contact->get_error_message(), array( 'type' => array( 'provider', 'error' ), 'parent' => $entry_id, 'form_id' => $form_data['id'], ) ); continue; } /* * Setup Merge Vars */ $merge_vars = array(); foreach ( $connection['fields'] as $name => $merge_var ) { // Don't include Email or Full name fields. if ( 'email' === $name ) { continue; } // Check if merge var is mapped. if ( empty( $merge_var ) ) { continue; } $merge_var = explode( '.', $merge_var ); $id = $merge_var[0]; $key = ! empty( $merge_var[1] ) ? $merge_var[1] : 'value'; // Check if mapped form field has a value. if ( empty( $fields[ $id ][ $key ] ) ) { continue; } $value = $fields[ $id ][ $key ]; // Constant Contact doesn't native URL field so it has to be // stored in a custom field. if ( 'url' === $name ) { $merge_vars['custom_fields'] = array( array( 'name' => 'custom_field_1', 'value' => $value, ), ); continue; } // Constant Contact stores name in two fields, so we have to // separate it. if ( 'full_name' === $name ) { $names = explode( ' ', $value ); if ( ! empty( $names[0] ) ) { $merge_vars['first_name'] = $names[0]; } if ( ! empty( $names[1] ) ) { $merge_vars['last_name'] = $names[1]; } continue; } // Constant Contact stores address in multiple fields, so we // have to separate it. if ( $name === 'address' ) { // Only support Address fields. if ( $fields[ $id ]['type'] !== 'address' ) { continue; } // Postal code may be in extended US format. $postal = [ 'code' => '', 'subcode' => '', ]; if ( ! empty( $fields[ $id ]['postal'] ) ) { $p = explode( '-', $fields[ $id ]['postal'] ); $postal['code'] = ! empty( $p[0] ) ? $p[0] : ''; $postal['subcode'] = ! empty( $p[1] ) ? $p[1] : ''; } $merge_vars['addresses'] = [ [ 'address_type' => 'BUSINESS', 'city' => ! empty( $fields[ $id ]['city'] ) ? $fields[ $id ]['city'] : '', 'country_code' => ! empty( $fields[ $id ]['country'] ) ? $fields[ $id ]['country'] : '', 'line1' => ! empty( $fields[ $id ]['address1'] ) ? $fields[ $id ]['address1'] : '', 'line2' => ! empty( $fields[ $id ]['address2'] ) ? $fields[ $id ]['address2'] : '', 'postal_code' => $postal['code'], 'state' => ! empty( $fields[ $id ]['state'] ) ? $fields[ $id ]['state'] : '', 'sub_postal_code' => $postal['subcode'], ], ]; continue; } $merge_vars[ $name ] = $value; } /* * Process in API */ // If we have a previous contact, only update the list association. if ( ! empty( $contact['results'] ) ) { $data = $contact['results'][0]; // Check if they are already assigned to lists. if ( ! empty( $data['lists'] ) ) { foreach ( $data['lists'] as $list ) { // If they are already assigned to this list, return early. if ( isset( $list['id'] ) && (string) $list_id === (string) $list['id'] ) { return; } } // Otherwise, add them to the list. $data['lists'][ count( $data['lists'] ) ] = [ 'id' => $list_id, 'status' => 'ACTIVE', ]; } else { // Add the contact to the list. $data['lists'][0] = [ 'id' => $list_id, 'status' => 'ACTIVE', ]; } // Combine merge vars into data before sending. $data = array_merge( $data, $merge_vars ); // Args to use. $args = [ 'body' => wp_json_encode( $data ), 'method' => 'PUT', 'headers' => [ 'Content-Type' => 'application/json', ], ]; $update = wp_remote_request( 'https://api.constantcontact.com/v2/contacts/' . $data['id'] . '?api_key=' . $this->api_key . '&access_token=' . $this->access_token . '&action_by=ACTION_BY_VISITOR', $args ); $res = json_decode( wp_remote_retrieve_body( $update ), true ); } else { // Add a new contact. $data = [ 'email_addresses' => [ [ 'email_address' => $email ] ], 'lists' => [ [ 'id' => $list_id ] ], ]; // Combine merge vars into data before sending. $data = array_merge( $data, $merge_vars ); // Args to use. $args = [ 'body' => wp_json_encode( $data ), 'headers' => [ 'Content-Type' => 'application/json', ], ]; $add = wp_remote_post( 'https://api.constantcontact.com/v2/contacts?api_key=' . $this->api_key . '&access_token=' . $this->access_token . '&action_by=ACTION_BY_VISITOR', $args ); $res = json_decode( wp_remote_retrieve_body( $add ), true ); } // Check for errors. if ( isset( $res['error_key'] ) ) { wpforms_log( esc_html__( 'Constant Contact API Error', 'wpforms-lite' ), $res->get_error_message(), [ 'type' => [ 'provider', 'error' ], 'parent' => $entry_id, 'form_id' => $form_data['id'], ] ); } endforeach; } /************************************************************************ * API methods - these methods interact directly with the provider API. * ************************************************************************/ /** * Authenticate with the API. * * @since 1.3.6 * * @param array $data * @param string $form_id * * @return mixed id or error object */ public function api_auth( $data = array(), $form_id = '' ) { $id = uniqid(); $providers = wpforms_get_providers_options(); $providers[ $this->slug ][ $id ] = array( 'access_token' => sanitize_text_field( $data['authcode'] ), 'label' => sanitize_text_field( $data['label'] ), 'date' => time(), ); update_option( 'wpforms_providers', $providers ); return $id; } /** * Establish connection object to API. * * @since 1.3.6 * * @param string $account_id * * @return mixed array or error object. */ public function api_connect( $account_id ) { if ( ! empty( $this->api[ $account_id ] ) ) { return $this->api[ $account_id ]; } else { $providers = wpforms_get_providers_options(); if ( ! empty( $providers[ $this->slug ][ $account_id ] ) ) { $this->api[ $account_id ] = true; $this->access_token = $providers[ $this->slug ][ $account_id ]['access_token']; } else { return $this->error( 'API error' ); } } } /** * Retrieve provider account lists. * * @since 1.3.6 * * @param string $connection_id * @param string $account_id * * @return mixed array or error object */ public function api_lists( $connection_id = '', $account_id = '' ) { $this->api_connect( $account_id ); $request = wp_remote_get( 'https://api.constantcontact.com/v2/lists?api_key=' . $this->api_key . '&access_token=' . $this->access_token ); $lists = json_decode( wp_remote_retrieve_body( $request ), true ); if ( empty( $lists ) ) { wpforms_log( esc_html__( 'Constant Contact API Error', 'wpforms-lite' ), '', array( 'type' => array( 'provider', 'error' ), ) ); return $this->error( esc_html__( 'API list error: Constant API error', 'wpforms-lite' ) ); } return $lists; } /** * Retrieve provider account list fields. * * @since 1.3.6 * * @param string $connection_id * @param string $account_id * @param string $list_id * * @return mixed array or error object */ public function api_fields( $connection_id = '', $account_id = '', $list_id = '' ) { $provider_fields = array( array( 'name' => 'Email', 'field_type' => 'email', 'req' => '1', 'tag' => 'email', ), array( 'name' => 'Full Name', 'field_type' => 'name', 'tag' => 'full_name', ), array( 'name' => 'First Name', 'field_type' => 'first', 'tag' => 'first_name', ), array( 'name' => 'Last Name', 'field_type' => 'last', 'tag' => 'last_name', ), array( 'name' => 'Phone', 'field_type' => 'text', 'tag' => 'work_phone', ), array( 'name' => 'Website', 'field_type' => 'text', 'tag' => 'url', ), array( 'name' => 'Address', 'field_type' => 'address', 'tag' => 'address', ), array( 'name' => 'Job Title', 'field_type' => 'text', 'tag' => 'job_title', ), array( 'name' => 'Company', 'field_type' => 'text', 'tag' => 'company_name', ), ); return $provider_fields; } /************************************************************************* * Output methods - these methods generally return HTML for the builder. * *************************************************************************/ /** * Provider account authorize fields HTML. * * @since 1.3.6 * @return string */ public function output_auth() { $providers = wpforms_get_providers_options(); $class = ! empty( $providers[ $this->slug ] ) ? 'hidden' : ''; $output = '
'; $output .= sprintf( '

%s

', esc_html__( 'Add New Account', 'wpforms-lite' ) ); $output .= '

'; $output .= esc_html__( 'Please fill out all of the fields below to register your new Constant Contact account.', 'wpforms-lite' ); $output .= '
'; $output .= esc_html__( 'Click here for documentation on connecting WPForms with Constant Contact.', 'wpforms-lite' ); $output .= ''; $output .= '

'; $output .= '

'; $output .= esc_html__( 'Because Constant Contact requires external authentication, you will need to register WPForms with Constant Contact before you can proceed.', 'wpforms-lite' ); $output .= '

'; $output .= '

'; $output .= esc_html__( 'Click here to register with Constant Contact', 'wpforms-lite' ); $output .= '

'; $output .= sprintf( '', $this->name, esc_html__( 'Authorization Code', 'wpforms-lite' ) ); $output .= sprintf( '', $this->name, esc_html__( 'Account Nickname', 'wpforms-lite' ) ); $output .= sprintf( '', $this->slug, esc_html__( 'Connect', 'wpforms-lite' ) ); $output .= '
'; return $output; } /** * Provider account list groups HTML. * * @since 1.3.6 * * @param string $connection_id Connection Id. * @param array $connection Connection data. * * @return string */ public function output_groups( $connection_id = '', $connection = [] ) { // No groups or segments for this provider. return ''; } /** * Default content for the provider settings panel in the form builder. * * @since 1.6.8 * * @param string $content Default content. * * @return string */ public function builder_settings_default_content( $content ) { ob_start(); ?>

' . esc_html__( 'Learn more about the power of email marketing.', 'wpforms-lite' ) . '', esc_url( admin_url( 'admin.php?page=wpforms-page&wpforms-page=constant-contact' ) ) ); ?>

'; $output .= ''; $output .= esc_html__( 'Click here for documentation on connecting WPForms with Constant Contact.', 'wpforms-lite' ); $output .= ''; $output .= '

'; $output .= '

'; $output .= esc_html__( 'Because Constant Contact requires external authentication, you will need to register WPForms with Constant Contact before you can proceed.', 'wpforms-lite' ); $output .= '

'; $output .= '

'; $output .= esc_html__( 'Click here to register with Constant Contact', 'wpforms-lite' ); $output .= '

'; $output .= sprintf( '', $this->name, esc_html__( 'Authorization Code', 'wpforms-lite' ) ); $output .= sprintf( '', $this->name, esc_html__( 'Account Nickname', 'wpforms-lite' ) ); echo $output; } /************************ * Other functionality. * ************************/ /** * Add admin notices to connect to Constant Contact. * * @since 1.3.6 */ public function connect_request() { // Only consider showing the review request to admin users. if ( ! is_super_admin() ) { return; } // Don't display on WPForms admin content pages. if ( ! empty( $_GET['wpforms-page'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended return; } // Don't display if user is about to connect via Settings page. if ( ! empty( $_GET['wpforms-integration'] ) && $this->slug === $_GET['wpforms-integration'] ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended return; } // Only display the notice if the Constant Contact option is set and // there are previous Constant Contact connections created. // Please do not delete 'wpforms_constant_contact' option check from the code. $cc_notice = get_option( 'wpforms_constant_contact', false ); $providers = wpforms_get_providers_options(); if ( ! $cc_notice || ! empty( $providers[ $this->slug ] ) ) { return; } // Output the notice message. $connect = admin_url( 'admin.php?page=wpforms-settings&wpforms-integration=constant-contact#!wpforms-tab-providers' ); $learn_more = admin_url( 'admin.php?page=wpforms-page&wpforms-page=constant-contact' ); ob_start(); ?>

WPForms plugin — use it with an active Constant Contact account.', 'wpforms-lite' ), [ 'strong' => [], ] ); ?>

power of email marketing', 'wpforms-lite' ), [ 'a' => [ 'href' => [], ], ] ), esc_url( $learn_more ) ); ?>

\WPForms\Admin\Notice::DISMISS_GLOBAL, 'slug' => 'constant_contact_connect', 'autop' => false, 'class' => 'wpforms-constant-contact-notice', ] ); } /** * Dismiss the Constant Contact admin notice. * * @since 1.3.6 * @since 1.6.7.1 Added parameter $notice_id. * * @param string $notice_id Notice ID (slug). */ public function connect_dismiss( $notice_id = '' ) { if ( $notice_id !== 'global-constant_contact_connect' ) { return; } delete_option( 'wpforms_constant_contact' ); wp_send_json_success(); } /** * Constant Contact "Learn More" admin page. * * @since 1.3.6 */ public function learn_more_page() { if ( empty( $_GET['page'] ) || empty( $_GET['wpforms-page'] ) || 'wpforms-page' !== $_GET['page'] || 'constant-contact' !== $_GET['wpforms-page'] ) { return; } $more = 'http://www.wpbeginner.com/beginners-guide/why-you-should-start-building-your-email-list-right-away'; ?>

$44 back for every $1 spent according to DMA.', 'wpforms-lite' ), array( 'strong' => array() ) ); ?>

  1. Email is still #1 - At least 91% of consumers check their email on a daily basis. You get direct access to your subscribers, without having to play by social media's rules and algorithms.', 'wpforms-lite' ), array( 'strong' => array() ) ); ?>
  2. You own your email list - Unlike with social media, your list is your property and no one can revoke your access to it.', 'wpforms-lite' ), array( 'strong' => array() ) ); ?>
  3. Email converts - People who buy products marketed through email spend 138% more than those who don't receive email offers.', 'wpforms-lite' ), array( 'strong' => array() ) ); ?>

why building your email list is so important.', 'wpforms-lite' ), array( 'a' => array( 'href' => array(), 'target' => array(), 'rel' => array(), ), ) ), $more ); ?>