Takayuki Miyoshi

Double Opt-In Helper is a WordPress plugin that helps developers implement the double opt-in process in their plugins.
<h4>What is double opt-in?</h4>
Double opt-in is a procedure used to confirm user’s consent. Today, service providers are required to obtain clear consent from users prior to collecting or using their personal data. In some situations, however, asking the user to tick an “I agree.” checkbox is not sufficient. Double opt-in serves a useful role in such situations.
A typical double opt-in process starts by the service provider sending an email message to the user. The message includes a URL link to the provider’s website and asks the user to click the link if they agree on conditions. Usually, the URL includes some sort of unique random code that works as a token to confirm the user’s consent.
By doing this, the service provider can confirm that the real user (not a bot or someone else) has consented, because only the user should be able to access messages to their email address.
<h4>I’m a developer. How can I use this plugin?</h4>
First, register an “agent” who can handle double opt-in sessions for you, and knows what to do when a user opts-in.
To register an agent, use the <code>doihelper_register_agent()</code> function. <code>doihelper_register_agent()</code> takes two parameters: the name of the agent (required), and an optional associative array of arguments. The available arguments are:
<ul>
<li><code>acceptance_period</code> — The length of time (in seconds) for how long a double opt-in session remains live. Default value: 86400 (24 hours)</li>
<li><code>optin_callback</code> — The callback function that will be called when a user opts-in.</li>
<li><code>email_callback</code> — The callback function that will be called to send a confirmation email.</li>
</ul>
After registering an agent, start a double opt-in session by calling the <code>doihelper_start_session()</code> function. <code>doihelper_start_session()</code> takes two parameters: the name of the agent (required), and an optional associative array of arguments. The available arguments are:
<ul>
<li><code>email_to</code> — The recipient’s email address, used for the confirmation email. If you omit this argument, no email will be sent. If you do not provide this argument, you will need to provide the user with the confirmation link another way.</li>
<li><code>properties</code> — The properties array of the session. This array is to be passed to the <code>optin_callback</code> function as its only parameter. While you can include any information into this, the primary purpose of it is to pass user-related data to the opt-in callback.</li>
</ul>
The session data will be stored in the database until the user opts-in, or the acceptance period (from <code>doihelper_register_agent()</code>) expires.

Double Opt-In Helper

Double Opt-In Helper is a WordPress plugin that helps developers implement the double opt-in process in their plugins.

Berg Informatik

Provides features and functions to create an opt-in or double-opt in with contact form 7 (cf7) and other form plugins.
<h3>Save contacts</h3>
To store your contacts, please install the additional plugin called bin contact. This plugin assists you installing all the necessary dependencies.
<h3>Opt-In Function</h3>
<pre>BinOptIn::optIn($postdata, [
 'opt_in_admin_message' => false,
 'double_opt_in' => false,
 'admin_unlock' => false,
 'unlock_message' => false
]);</pre>
<ul>
<li>
opt_in_admin_message 
(bool) Notify the site owner of any new contact, regardless of whether or not he has confirmed his e-mail address. Default false.
</li>
<li>
double_opt_in 
(bool) The contact must confirm the e-mail address by clicking on a confirmation link. Default false.
</li>
<li>
admin_unlock 
(bool) The site owner has to confirm every new contact by clicking on a confirmation link. This is useful if you want to show a list of contacts (like a committee or a list of supporters). Default false.
</li>
<li>
unlock_message 
(bool) This option allows you to specify whether the contact should receive a notification once the site owner has confirmed the committee subscription. Default false.
</li>
<li>
mailchimp_opt_in 
(bool) This option allows you to specify whether the contact will be forwarded to Mailchimp. Default false.
</li>
</ul>
<h3>Accepted postdata</h3>
<ul>
<li>
salutation 
(int) Default empty.
<ul>
<li>0 (Mister)</li>
<li>1 (Miss)</li>
<li>2 (Other)</li>
</ul>
</li>
<li>
polite_form 
(int) Default empty.
<ul>
<li>0 (Personally)</li>
<li>1 (Formally)</li>
</ul>
</li>
<li>
language_of_correspondence 
(int) Check this functions to see a list of all available languages: BinContact::formLanguage() and BinContact::formLanguageValue()
</li>
<li>
name_suffix 
(string) Default empty.
</li>
<li>
first_name 
(string) Default empty.
</li>
<li>
last_name 
(string) Default empty.
</li>
<li>
designation 
(string) Default empty.
</li>
<li>
mobile 
(string) Default empty.
</li>
<li>
phone_private 
(string) Default empty.
</li>
<li>
phone_work 
(string) Default empty.
</li>
<li>
street_and_number 
(string) Default empty.
</li>
<li>
zip 
(string) Default empty.
</li>
<li>
city 
(string) Default empty.
</li>
<li>
country 
(string) Default empty.
</li>
<li>
website 
(string) Default empty.
</li>
<li>
facebook 
(string) Default empty.
</li>
<li>
twitter 
(string) Default empty.
</li>
<li>
instagram 
(string) Default empty.
</li>
<li>
flickr 
(string) Default empty.
</li>
<li>
linkedin 
(string) Default empty.
</li>
<li>
xing 
(string) Default empty.
</li>
<li>
youtube 
(string) Default empty.
</li>
<li>
socialmedia_other1 
(string) Default empty.
</li>
<li>
socialmedia_other2 
(string) Default empty.
</li>
<li>
socialmedia_other3 
(string) Default empty.
</li>
<li>
terms_and_conditions_accepted 
(string) Default empty.
<ul>
<li>empty (Not filled)</li>
<li>no (No)</li>
<li>yes (Yes)</li>
</ul>
</li>
<li>
privacy_policy_accepted 
(string) Default empty.
<ul>
<li>empty (Not filled)</li>
<li>no (No)</li>
<li>yes (Yes)</li>
</ul>
</li>
<li>
contact_group 
(string) Comma seperated list of contact_group taxonomy terms or ID’s. Default empty.
</li>
</ul>
<h3>Integrate with Contact Form 7</h3>
Bin Opt-In works best with contact form seven. To integrate it into your contact forms, you need to add custom code like this to your theme functions.php.
<pre>add_action('wpcf7_before_send_mail', 'bin_opt_in_contact');
function bin_opt_in_contact($cf7)
{
 // Get current form id
 $formId = $cf7->id;

 // Array of form ids
 $forms = [159, 454];

 // Only apply to certain forms
 if(in_array($formId, $forms))
 {
 // Dont do anything if class is missing
 if(class_exists('BinOptIn'))
 {
 // At least, the email must be present
 if(is_email($_POST['email']))
 {
 // map salutation
 $salutationMap = [ 
 'Frau' => 0,
 'Madame' => 0,
 'Mrs' => 0,
 'Herr' => 1,
 'Monsieur' => 1,
 'Mr' => 1,
 '*' => 2
 ];

 // assign form data with corresponding meta fields
 $postdata = [];
 $postdata['email'] = sanitize_email($_POST['email']);
 $postdata['first_name'] = sanitize_text_field($_POST['first_name']);
 $postdata['last_name'] = sanitize_text_field($_POST['last_name']);
 $postdata['salutation'] = $salutationMap[$_POST['salutation']];
 $postdata['terms_and_conditions_accepted'] = isset($_POST['terms_and_conditions_accepted']) ? 'yes' : '';

 // save contact
 BinOptIn::optIn($postdata, [
 'opt_in_admin_message' => false,
 'double_opt_in' => false,
 'admin_unlock' => false,
 'unlock_message' => false
 ]);
 }
 }
 }
}</pre>
<h3>Integrate with Contact Form 7 Multi-Step Pro</h3>
Save form data at every step by using the filter wpcf7_validate.
<pre>
add_filter('wpcf7_validate', 'save_contact_step', 10, 2);
function save_contact_step($result, $tags)
{
 // Get current form id
 $formId = $_POST['_wpcf7'];

 // Array of form ids
 $forms = [159, 454];

 // Only apply to certain forms
 if(in_array($formId, $forms))
 {
 // Dont do anything if class is missing
 if(class_exists('BinOptIn'))
 {
 // save contact info here
 // BinOptIn::optIn()
 }
 }

 return $result;
}
</pre>

Opt-In

Provides features and functions to create an opt-in or double-opt in with contact form 7 (cf7) and other form plugins.

Double Opt-In Helper vs Opt-In