mc4wp_form_subscribed

Fires right after a form was used to subscribe.

Description

do_action( 'mc4wp_form_subscribed', (MC4WP_Form) $form, (string) $subscriber_email_address, (array) $data, (MC4WP_MailChimp_Subscriber[]) $map ); 

Parameters (4)

0. $form (MC4WP_Form)
Instance of the submitted form
1. $subscriber_email_address (string)
The subscriber email address.
2. $data (array)
The data.
3. $map (MC4WP_MailChimp_Subscriber[])
The map.

Usage

To run the hook, copy the example below.
  1. // run the action 
  2. do_action( 'mc4wp_form_subscribed', $form, $subscriber_email_address, $data, $map ); 
The following example is for adding a hook callback.
  1. // define the mc4wp_form_subscribed callback 
  2. function action_mc4wp_form_subscribed( $form, $subscriber_email_address, $data, $map ) { 
  3. // make action magic happen here... 
  4. }; 
  5.  
  6. // add the action 
  7. add_action( 'mc4wp_form_subscribed', 'action_mc4wp_form_subscribed', 10, 4 ); 
To remove a hook callback, use the example below.
  1. // remove the action 
  2. remove_action( 'mc4wp_form_subscribed', 'action_mc4wp_form_subscribed', 10, 4 ); 

Defined (1)

The action is defined in the following location(s).

/includes/forms/class-form-listener.php  
  1. do_action( 'mc4wp_form_subscribed', $form, $subscriber->email_address, $data, $map );