Title: Double Opt-In Helper
Author: Rock Lobster Inc.
Published: <strong>ޑިސެމްބަރ 10, 2021</strong>
Last modified: މެއި 7, 2024

---

Search plugins

This plugin **hasn’t been tested with the latest 3 major releases of WordPress**.
It may no longer be maintained or supported and may have compatibility issues when
used with more recent versions of WordPress.

![](https://s.w.org/plugins/geopattern-icon/doi-helper.svg)

# Double Opt-In Helper

 By [Rock Lobster Inc.](https://profiles.wordpress.org/rocklobsterinc/)

[Download](https://downloads.wordpress.org/plugin/doi-helper.zip)

 * [Details](https://dv.wordpress.org/plugins/doi-helper/#description)
 * [Reviews](https://dv.wordpress.org/plugins/doi-helper/#reviews)
 *  [Installation](https://dv.wordpress.org/plugins/doi-helper/#installation)
 * [Development](https://dv.wordpress.org/plugins/doi-helper/#developers)

 [Support](https://wordpress.org/support/plugin/doi-helper/)

## Description

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

#### What is double opt-in?

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.

#### I’m a developer. How can I use this plugin?

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 `doihelper_register_agent()` function. `doihelper_register_agent()`
takes two parameters: the name of the agent (required), and an optional associative
array of arguments. The available arguments are:

 * `acceptance_period` — The length of time (in seconds) for how long a double opt-
   in session remains live. Default value: 86400 (24 hours)
 * `optin_callback` — The callback function that will be called when a user opts-
   in.
 * `email_callback` — The callback function that will be called to send a confirmation
   email.

After registering an agent, start a double opt-in session by calling the `doihelper_start_session()`
function. `doihelper_start_session()` takes two parameters: the name of the agent(
required), and an optional associative array of arguments. The available arguments
are:

 * `email_to` — 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.
 * `properties` — The properties array of the session. This array is to be passed
   to the `optin_callback` 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.

The session data will be stored in the database until the user opts-in, or the acceptance
period (from `doihelper_register_agent()`) expires.

## Installation

 1. Upload the entire `doi-helper` folder to the `/wp-content/plugins/` directory.
 2. Activate the plugin through the **Plugins** screen (**Plugins > Installed Plugins**).

## Reviews

There are no reviews for this plugin.

## Contributors & Developers

“Double Opt-In Helper” is open source software. The following people have contributed
to this plugin.

Contributors

 *   [ Rock Lobster Inc. ](https://profiles.wordpress.org/rocklobsterinc/)
 *   [ Takayuki Miyoshi ](https://profiles.wordpress.org/takayukister/)

“Double Opt-In Helper” has been translated into 2 locales. Thank you to [the translators](https://translate.wordpress.org/projects/wp-plugins/doi-helper/contributors)
for their contributions.

[Translate “Double Opt-In Helper” into your language.](https://translate.wordpress.org/projects/wp-plugins/doi-helper)

### Interested in development?

[Browse the code](https://plugins.trac.wordpress.org/browser/doi-helper/), check
out the [SVN repository](https://plugins.svn.wordpress.org/doi-helper/), or subscribe
to the [development log](https://plugins.trac.wordpress.org/log/doi-helper/) by 
[RSS](https://plugins.trac.wordpress.org/log/doi-helper/?limit=100&mode=stop_on_copy&format=rss).

## Changelog

#### 1.0

 * Bumps up the minimum required WordPress version to 6.1.
 * Bumps up the minimum required PHP version to 7.4.

#### 0.73

Initial release.

## Meta

 *  Version **1.0**
 *  Last updated **2 years ago**
 *  Active installations **100+**
 *  WordPress version ** 6.4 or higher **
 *  Tested up to **6.5.8**
 *  PHP version ** 7.4 or higher **
 *  Languages
 * [English (US)](https://wordpress.org/plugins/doi-helper/), [German](https://de.wordpress.org/plugins/doi-helper/),
   and [Japanese](https://ja.wordpress.org/plugins/doi-helper/).
 *  [Translate into your language](https://translate.wordpress.org/projects/wp-plugins/doi-helper)
 * Tags
 * [consent](https://dv.wordpress.org/plugins/tags/consent/)[Opt-in](https://dv.wordpress.org/plugins/tags/opt-in/)
   [privacy](https://dv.wordpress.org/plugins/tags/privacy/)
 *  [Advanced View](https://dv.wordpress.org/plugins/doi-helper/advanced/)

## Ratings

No reviews have been submitted yet.

[Your review](https://wordpress.org/support/plugin/doi-helper/reviews/#new-post)

[See all reviews](https://wordpress.org/support/plugin/doi-helper/reviews/)

## Contributors

 *   [ Rock Lobster Inc. ](https://profiles.wordpress.org/rocklobsterinc/)
 *   [ Takayuki Miyoshi ](https://profiles.wordpress.org/takayukister/)

## Support

Got something to say? Need help?

 [View support forum](https://wordpress.org/support/plugin/doi-helper/)

## Donate

Would you like to support the advancement of this plugin?

 [ Donate to this plugin ](https://contactform7.com/donate/)