class-Inbound_Confirm_Double_Optin.html

<!DOCTYPE html>
<html>
<head>
	<meta charset="utf-8">

	<title>Class Inbound_Confirm_Double_Optin | Inbound Pro Plugin - PHP Codex</title>

	<link rel="stylesheet" href="resources/style.css?c2f33731c1948fbed7c333554678bfa68d4817da">

</head>

<body>
<div id="left">
	<div id="menu">
		<a href="index.html" title="Overview"><span>Overview</span></a>


		<div id="groups">
				<h3>Packages</h3>
			<ul>
				<li>
					<a href="package-ACF.html">
						ACF					</a>

						</li>
				<li>
					<a href="package-Automation.html">
						Automation<span></span>
					</a>

						<ul>
				<li>
					<a href="package-Automation.Actions.html">
						Actions					</a>

						</li>
				<li>
					<a href="package-Automation.Activation.html">
						Activation					</a>

						</li>
				<li>
					<a href="package-Automation.LeadProfile.html">
						LeadProfile					</a>

						</li>
				<li>
					<a href="package-Automation.Menus.html">
						Menus					</a>

						</li>
				<li>
					<a href="package-Automation.Queries.html">
						Queries					</a>

						</li>
				<li>
					<a href="package-Automation.Rules.html">
						Rules					</a>

						</li>
				<li>
					<a href="package-Automation.Triggers.html">
						Triggers					</a>

						</li>
							</ul></li>
				<li>
					<a href="package-CTA.html">
						CTA<span></span>
					</a>

						<ul>
				<li>
					<a href="package-CTA.Activation.html">
						Activation					</a>

						</li>
				<li>
					<a href="package-CTA.AJAXListeners.html">
						AJAXListeners					</a>

						</li>
				<li>
					<a href="package-CTA.Cloning.html">
						Cloning					</a>

						</li>
				<li>
					<a href="package-CTA.Core.html">
						Core					</a>

						</li>
				<li>
					<a href="package-CTA.Display.html">
						Display					</a>

						</li>
				<li>
					<a href="package-CTA.EditPage.html">
						EditPage					</a>

						</li>
				<li>
					<a href="package-CTA.Enqueues.html">
						Enqueues					</a>

						</li>
				<li>
					<a href="package-CTA.GPLSettings.html">
						GPLSettings					</a>

						</li>
				<li>
					<a href="package-CTA.LeadsProfile.html">
						LeadsProfile					</a>

						</li>
				<li>
					<a href="package-CTA.Loading.html">
						Loading					</a>

						</li>
				<li>
					<a href="package-CTA.Menus.html">
						Menus					</a>

						</li>
				<li>
					<a href="package-CTA.Notices.html">
						Notices					</a>

						</li>
				<li>
					<a href="package-CTA.PlacementMetabox.html">
						PlacementMetabox					</a>

						</li>
				<li>
					<a href="package-CTA.PostType.html">
						PostType					</a>

						</li>
				<li>
					<a href="package-CTA.Templates.html">
						Templates					</a>

						</li>
				<li>
					<a href="package-CTA.Tracking.html">
						Tracking					</a>

						</li>
				<li>
					<a href="package-CTA.Variations.html">
						Variations					</a>

						</li>
				<li>
					<a href="package-CTA.YOAST.html">
						YOAST					</a>

						</li>
							</ul></li>
				<li>
					<a href="package-InboundPro.html">
						InboundPro<span></span>
					</a>

						<ul>
				<li>
					<a href="package-InboundPro.Activation.html">
						Activation					</a>

						</li>
				<li>
					<a href="package-InboundPro.AdminAJAX.html">
						AdminAJAX					</a>

						</li>
				<li>
					<a href="package-InboundPro.AutoLoading.html">
						AutoLoading					</a>

						</li>
				<li>
					<a href="package-InboundPro.Cron.html">
						Cron					</a>

						</li>
				<li>
					<a href="package-InboundPro.DataInterface.html">
						DataInterface					</a>

						</li>
				<li>
					<a href="package-InboundPro.FieldMapping.html">
						FieldMapping					</a>

						</li>
				<li>
					<a href="package-InboundPro.Funnels.html">
						Funnels					</a>

						</li>
				<li>
					<a href="package-InboundPro.InboundNowAPI.html">
						InboundNowAPI					</a>

						</li>
				<li>
					<a href="package-InboundPro.Installer.html">
						Installer					</a>

						</li>
				<li>
					<a href="package-InboundPro.LeadStatuses.html">
						LeadStatuses					</a>

						</li>
				<li>
					<a href="package-InboundPro.Menus.html">
						Menus					</a>

						</li>
				<li>
					<a href="package-InboundPro.Notifications.html">
						Notifications					</a>

						</li>
				<li>
					<a href="package-InboundPro.Ouath.html">
						Ouath					</a>

						</li>
				<li>
					<a href="package-InboundPro.Reports.html">
						Reports					</a>

						</li>
				<li>
					<a href="package-InboundPro.Settings.html">
						Settings					</a>

						</li>
				<li>
					<a href="package-InboundPro.Tracking.html">
						Tracking					</a>

						</li>
				<li>
					<a href="package-InboundPro.Translations.html">
						Translations					</a>

						</li>
				<li>
					<a href="package-InboundPro.Updates.html">
						Updates					</a>

						</li>
							</ul></li>
				<li>
					<a href="package-LandingPages.html">
						LandingPages<span></span>
					</a>

						<ul>
				<li>
					<a href="package-LandingPages.Activation.html">
						Activation					</a>

						</li>
				<li>
					<a href="package-LandingPages.DataInterfaces.html">
						DataInterfaces					</a>

						</li>
				<li>
					<a href="package-LandingPages.Management.html">
						Management					</a>

						</li>
				<li>
					<a href="package-LandingPages.Menus.html">
						Menus					</a>

						</li>
				<li>
					<a href="package-LandingPages.NeedsAttention.html">
						NeedsAttention					</a>

						</li>
				<li>
					<a href="package-LandingPages.Notices.html">
						Notices					</a>

						</li>
				<li>
					<a href="package-LandingPages.Sidebars.html">
						Sidebars					</a>

						</li>
				<li>
					<a href="package-LandingPages.Templates.html">
						Templates					</a>

						</li>
				<li>
					<a href="package-LandingPages.Tracking.html">
						Tracking					</a>

						</li>
				<li>
					<a href="package-LandingPages.Variations.html">
						Variations					</a>

						</li>
				<li>
					<a href="package-LandingPages.WelcomeScreen.html">
						WelcomeScreen					</a>

						</li>
				<li>
					<a href="package-LandingPages.Widgets.html">
						Widgets					</a>

						</li>
							</ul></li>
				<li>
					<a href="package-Leads.html">
						Leads<span></span>
					</a>

						<ul>
				<li>
					<a href="package-Leads.Activation.html">
						Activation					</a>

						</li>
				<li>
					<a href="package-Leads.Akismet.html">
						Akismet					</a>

						</li>
				<li>
					<a href="package-Leads.BranchControl.html">
						BranchControl					</a>

						</li>
				<li>
					<a href="package-Leads.BulkActions.html">
						BulkActions					</a>

						</li>
				<li>
					<a href="package-Leads.Dashboard.html">
						Dashboard					</a>

						</li>
				<li>
					<a href="package-Leads.Management.html">
						Management					</a>

						</li>
				<li>
					<a href="package-Leads.Notifications.html">
						Notifications					</a>

						</li>
				<li>
					<a href="package-Leads.Settings.html">
						Settings					</a>

						</li>
				<li>
					<a href="package-Leads.Tracking.html">
						Tracking					</a>

						</li>
				<li>
					<a href="package-Leads.UserProfile.html">
						UserProfile					</a>

						</li>
				<li>
					<a href="package-Leads.WPLogin.html">
						WPLogin					</a>

						</li>
							</ul></li>
				<li>
					<a href="package-Mailer.html">
						Mailer<span></span>
					</a>

						<ul>
				<li>
					<a href="package-Mailer.Activation.html">
						Activation					</a>

						</li>
				<li>
					<a href="package-Mailer.Admin.html">
						Admin					</a>

						</li>
				<li>
					<a href="package-Mailer.ClickTracking.html">
						ClickTracking					</a>

						</li>
				<li>
					<a href="package-Mailer.DataInterface.html">
						DataInterface					</a>

						</li>
				<li>
					<a href="package-Mailer.InboundForms.html">
						InboundForms					</a>

						</li>
				<li>
					<a href="package-Mailer.Leads.html">
						Leads					</a>

						</li>
				<li>
					<a href="package-Mailer.Management.html">
						Management					</a>

						</li>
				<li>
					<a href="package-Mailer.Notifications.html">
						Notifications					</a>

						</li>
				<li>
					<a href="package-Mailer.Scheduling.html">
						Scheduling					</a>

						</li>
				<li>
					<a href="package-Mailer.Sending.html">
						Sending					</a>

						</li>
				<li>
					<a href="package-Mailer.Settings.html">
						Settings					</a>

						</li>
				<li>
					<a href="package-Mailer.ShortcodesAndTokens.html">
						ShortcodesAndTokens					</a>

						</li>
				<li>
					<a href="package-Mailer.SparkPost.html">
						SparkPost					</a>

						</li>
				<li>
					<a href="package-Mailer.Templates.html">
						Templates					</a>

						</li>
				<li>
					<a href="package-Mailer.Unsubscribes.html">
						Unsubscribes					</a>

						</li>
				<li>
					<a href="package-Mailer.Variations.html">
						Variations					</a>

						</li>
				<li>
					<a href="package-Mailer.YoastSEO.html">
						YoastSEO					</a>

						</li>
							</ul></li>
				<li>
					<a href="package-None.html">
						None					</a>

						</li>
				<li>
					<a href="package-Shared.html">
						Shared<span></span>
					</a>

						<ul>
				<li>
					<a href="package-Shared.APIs.html">
						APIs					</a>

						</li>
				<li>
					<a href="package-Shared.CPT.html">
						CPT					</a>

						</li>
				<li>
					<a href="package-Shared.DatabaseRoutines.html">
						DatabaseRoutines					</a>

						</li>
				<li>
					<a href="package-Shared.DebugTricks.html">
						DebugTricks					</a>

						</li>
				<li>
					<a href="package-Shared.DoubleOptin.html">
						DoubleOptin					</a>

						</li>
				<li>
					<a href="package-Shared.EventManagement.html">
						EventManagement					</a>

						</li>
				<li>
					<a href="package-Shared.FieldMapping.html">
						FieldMapping					</a>

						</li>
				<li>
					<a href="package-Shared.InboundForms.html">
						InboundForms					</a>

						</li>
				<li>
					<a href="package-Shared.LeadSorage.html">
						LeadSorage					</a>

						</li>
				<li>
					<a href="package-Shared.MarketingButton.html">
						MarketingButton					</a>

						</li>
				<li>
					<a href="package-Shared.Menus.html">
						Menus					</a>

						</li>
				<li>
					<a href="package-Shared.Notifications.html">
						Notifications					</a>

						</li>
				<li>
					<a href="package-Shared.Shortcodes.html">
						Shortcodes					</a>

						</li>
				<li>
					<a href="package-Shared.ShortcodesAndTokens.html">
						ShortcodesAndTokens					</a>

						</li>
				<li>
					<a href="package-Shared.StandAloneLicensing.html">
						StandAloneLicensing					</a>

						</li>
				<li>
					<a href="package-Shared.Tracking.html">
						Tracking					</a>

						</li>
				<li>
					<a href="package-Shared.VisualEditor.html">
						VisualEditor					</a>

						</li>
							</ul></li>
				<li>
					<a href="package-xDepreciated.html">
						xDepreciated					</a>

						</li>
			</ul>
		</div>

		<hr>


		<div id="elements">
			<h3>Classes</h3>
			<ul>
				<li class="active"><a href="class-Inbound_Confirm_Double_Optin.html">Inbound_Confirm_Double_Optin</a></li>
				<li><a href="class-Inbound_List_Double_Optin.html">Inbound_List_Double_Optin</a></li>
			</ul>


		</div>
	</div>
</div>

<div id="splitter"></div>

<div id="right">
<div id="rightInner">
	<form id="search">
		<input type="hidden" name="cx" value="">
		<input type="hidden" name="ie" value="UTF-8">
		<input type="text" name="q" class="text" placeholder="Search">
	</form>

	<div id="navigation">
		<ul>
			<li>
				<a href="index.html" title="Overview"><span>Overview</span></a>
			</li>
			<li>
<span>Package</span>			</li>
			<li class="active">
<span>Class</span>			</li>
		</ul>
		<ul>
		</ul>
		<ul>
		</ul>
	</div>

<div id="content" class="class">
	<h1>Class Inbound_Confirm_Double_Optin</h1>


	<div class="info">
		
		
		<b>Package:</b> <a href="package-Shared.html">Shared</a>\<a href="package-Shared.DoubleOptin.html">DoubleOptin</a><br>

			<b>Located at</b> <a href="source-class-Inbound_Confirm_Double_Optin.html#10-205" title="Go to source code">core/shared/classes/class.confirm-double-optin.php</a>
		<br>
	</div>


	<table class="summary methods" id="methods">
	<caption>Methods summary</caption>
	<tr data-order="__construct" id="___construct">

		<td class="attributes"><code>
			 public 

			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#___construct">#</a>
		<code><a href="source-class-Inbound_Confirm_Double_Optin.html#12-17" title="Go to source code">__construct</a>( )</code>

		<div class="description short">
			<p>Initialize class</p>
		</div>

		<div class="description detailed hidden">
			<p>Initialize class</p>


		</div>
		</div></td>
	</tr>
	<tr data-order="add_hooks" id="_add_hooks">

		<td class="attributes"><code>
			 public static

			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_add_hooks">#</a>
		<code><a href="source-class-Inbound_Confirm_Double_Optin.html#19-31" title="Go to source code">add_hooks</a>( )</code>

		<div class="description short">
			<p>Load Hooks and Filters</p>
		</div>

		<div class="description detailed hidden">
			<p>Load Hooks and Filters</p>


		</div>
		</div></td>
	</tr>
	<tr data-order="process_confrimation" id="_process_confrimation">

		<td class="attributes"><code>
			 public static

			string
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_process_confrimation">#</a>
		<code><a href="source-class-Inbound_Confirm_Double_Optin.html#34-56" title="Go to source code">process_confrimation</a>( <span> <var>$atts</var>,…</span> )</code>

		<div class="description short">
			
		</div>

		<div class="description detailed hidden">
			

				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$atts</var>,…</dt>
					<dd></dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					string
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="render_confirm_link" id="_render_confirm_link">

		<td class="attributes"><code>
			 public static

			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_render_confirm_link">#</a>
		<code><a href="source-class-Inbound_Confirm_Double_Optin.html#59-87" title="Go to source code">render_confirm_link</a>( <span> <var>$params</var></span> )</code>

		<div class="description short">
			<p>Creates the double optin confirmation link
The shorcode used by the user is: inbound-list-double-optin-link.
But Inbound_List_Double_Optin::add_confirm_link_shortcode_params trims the name to: list-double-optin-link.
Then it gets rendered.
The reason for this is so the shorcode isn't rendered until the atts have been added to it.</p>
		</div>

		<div class="description detailed hidden">
			<p>Creates the double optin confirmation link
The shorcode used by the user is: inbound-list-double-optin-link.
But Inbound_List_Double_Optin::add_confirm_link_shortcode_params trims the name to: list-double-optin-link.
Then it gets rendered.
The reason for this is so the shorcode isn't rendered until the atts have been added to it.</p>


		</div>
		</div></td>
	</tr>
	<tr data-order="generate_confirm_link" id="_generate_confirm_link">

		<td class="attributes"><code>
			 public static

			STRING
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_generate_confirm_link">#</a>
		<code><a href="source-class-Inbound_Confirm_Double_Optin.html#91-123" title="Go to source code">generate_confirm_link</a>( <span>ARRAY <var>$params</var></span> )</code>

		<div class="description short">
			<p>Generates confirm url given lead id and lists</p>
		</div>

		<div class="description detailed hidden">
			<p>Generates confirm url given lead id and lists</p>


				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$params</var></dt>
					<dd>contains: lead_id (INT ), list_ids (MIXED), email_id (INT)</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					STRING<br>$confirm_url
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="decode_confirm_token" id="_decode_confirm_token">

		<td class="attributes"><code>
			 public static

			ARRAY
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_decode_confirm_token">#</a>
		<code><a href="source-class-Inbound_Confirm_Double_Optin.html#127-142" title="Go to source code">decode_confirm_token</a>( <span>STRING <var>$token</var></span> )</code>

		<div class="description short">
			<p>Decodes confirm token into an array of parameters</p>
		</div>

		<div class="description detailed hidden">
			<p>Decodes confirm token into an array of parameters</p>


				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$token</var></dt>
					<dd>$reader_id Encoded lead id.</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					ARRAY<br>$confirm array of confirmation data
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="confirm_being_added_to_lists" id="_confirm_being_added_to_lists">

		<td class="attributes"><code>
			 public static

			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_confirm_being_added_to_lists">#</a>
		<code><a href="source-class-Inbound_Confirm_Double_Optin.html#144-204" title="Go to source code">confirm_being_added_to_lists</a>( <span> <var>$params</var></span>, <span> <var>$all</var> = <span class="php-keyword1">false</span></span> )</code>

		<div class="description short">
			<p>Adds the lead to lists he selected when filling out the confirmation form.
If all_lists was selected, all lists currently waiting for confirmation will be selected and the lead will be added to those.</p>
		</div>

		<div class="description detailed hidden">
			<p>Adds the lead to lists he selected when filling out the confirmation form.
If all_lists was selected, all lists currently waiting for confirmation will be selected and the lead will be added to those.</p>


		</div>
		</div></td>
	</tr>
	</table>


</div>

	<div id="footer">
		Inbound Pro Plugin - PHP Codex API documentation generated by <a href="http://apigen.org">ApiGen</a>
	</div>
</div>
</div>
<script src="resources/combined.js"></script>
<script src="elementlist.js"></script>
</body>
</html>