{"id":10123,"date":"2013-12-02T16:34:12","date_gmt":"2013-12-02T16:34:12","guid":{"rendered":"http:\/\/www.oik-plugins.com\/?page_id=10123"},"modified":"2013-12-02T16:34:12","modified_gmt":"2013-12-02T16:34:12","slug":"oik-squeeze-apis","status":"publish","type":"page","link":"https:\/\/www.oik-plugins.com\/apis\/oik-squeeze-apis\/","title":{"rendered":"oik-squeeze APIs"},"content":{"rendered":"Application Programming Interfaces for the <span class=\"bw_plug\"><a class=\"plugin\" href=\"https:\/\/www.oik-plugins.com\/oik-plugins\/oik-squeeze\/\" title=\"Link to the oik-squeeze (oik-squeeze: squeeze page WordPress plugin) plugin\">oik-squeeze<\/a><\/span> plugin:\r\n\r\n<ul class=\"bw_list\"><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/bw_form_field__oiksp_message\/\">bw_form_field__oiksp_message() <span class=\"summary\">&#8211; Format the &quot;_oiksp_message&quot; field &#8211; setting a default if required<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/bw_squeeze\/\">bw_squeeze() <span class=\"summary\">&#8211; Implement the &#091;bw_squeeze] shortcode<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/bw_squeeze_form\/\">bw_squeeze_form() <span class=\"summary\">&#8211; Handle the squeeze form or popup<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksc_ajax_nopriv_oiksp_form\/\">oiksc_ajax_nopriv_oiksp_form() <span class=\"summary\">&#8211; Implement &quot;wp_ajax_nopriv_oiksp_form&quot; action to display the squeeze page opt-in form for visitors<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_admin_menu\/\">oiksp_admin_menu() <span class=\"summary\">&#8211; Implement &quot;oik_admin_menu&quot; for oik-squeeze<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_ajax_oiksp_form\/\">oiksp_ajax_oiksp_form() <span class=\"summary\">&#8211; Implement &quot;wp_ajax_oiksp_form&quot; action to display the squeeze page opt-in form<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_build_redirect\/\">oiksp_build_redirect() <span class=\"summary\">&#8211; Return the correct link for the opted-in page for this user<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_check_authority\/\">oiksp_check_authority() <span class=\"summary\">&#8211; Check overriding authority to view this opted-in page<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_check_confirm\/\">oiksp_check_confirm() <span class=\"summary\">&#8211; Check the confirm value against the one registered<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_check_contact\/\">oiksp_check_contact() <span class=\"summary\">&#8211; Check that the contact is valid and matches the name and (when required) confirm field<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_check_name\/\">oiksp_check_name() <span class=\"summary\">&#8211; Check the name given against the one registered<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_check_status\/\">oiksp_check_status() <span class=\"summary\">&#8211; Check the status of the oik_contact record for the opt-in requirements of the opted-in page<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_confirmed_contact\/\">oiksp_confirmed_contact() <span class=\"summary\">&#8211; Let the 3rd party email system know about the contact<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_confirmed_contact_madmimi\/\">oiksp_confirmed_contact_madmimi() <span class=\"summary\">&#8211; Perform the &quot;oiksp_confirmed_contact&quot; action for a MadMimi mailing list<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_confirmed_contact_mailpoet\/\">oiksp_confirmed_contact_mailpoet() <span class=\"summary\">&#8211; Perform the &quot;oiksp_confirmed_contact&quot; action for a MailPoet mailing list<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_create_contact\/\">oiksp_create_contact() <span class=\"summary\">&#8211; Create the oik_contact record for the first contact<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_create_oik_contact\/\">oiksp_create_oik_contact() <span class=\"summary\">&#8211; Create an oik_contact record programmatically<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_default\/\">oiksp_default() <span class=\"summary\">&#8211; Return the default option value from the bw_squeeze profile<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_display_confirmation\/\">oiksp_display_confirmation() <span class=\"summary\">&#8211;<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_display_opted_in_excerpt\/\">oiksp_display_opted_in_excerpt() <span class=\"summary\">&#8211; Display the excerpt from the opted_in page<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_display_squeeze_form\/\">oiksp_display_squeeze_form() <span class=\"summary\">&#8211; Display the signup form for the squeeze page\nThis version doesn&#8217;t let other plugins play **?**<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_display_squeeze_popup\/\">oiksp_display_squeeze_popup() <span class=\"summary\">&#8211; Display the squeeze page popup link<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_email_body_label\/\">oiksp_email_body_label() <span class=\"summary\">&#8211; Return email body label, showing an example<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_email_content_types\/\">oiksp_email_content_types() <span class=\"summary\">&#8211; Return the list of email content types<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_generate_confirm\/\">oiksp_generate_confirm() <span class=\"summary\">&#8211; Generate a 26 digit confirmation key for the double opt-in<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_get_contact\/\">oiksp_get_contact() <span class=\"summary\">&#8211; Load an oik_contact record by the email address<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_get_double\/\">oiksp_get_double() <span class=\"summary\">&#8211; Retrieve the double opt-in requirement of the opted-in page<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_get_email_default\/\">oiksp_get_email_default() <span class=\"summary\">&#8211; Return a default email message for double opt-in<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_get_email_headers\/\">oiksp_get_email_headers() <span class=\"summary\">&#8211; Set the email headers for the wp_mail() <span class=\"summary\">call<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_get_email_message\/\">oiksp_get_email_message() <span class=\"summary\">&#8211; Build the email message<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_get_email_subject\/\">oiksp_get_email_subject() <span class=\"summary\">&#8211; Return the subject of the email<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_get_status\/\">oiksp_get_status() <span class=\"summary\">&#8211;<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_init\/\">oiksp_init() <span class=\"summary\">&#8211; Implement &quot;oik_fields_loaded&quot; action for oik-squeeze<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_lazy_admin_menu\/\">oiksp_lazy_admin_menu() <span class=\"summary\">&#8211; Display the menu for squeeze settings  ( &quot;bw_squeeze&quot; )<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_lazy_redirect\/\">oiksp_lazy_redirect() <span class=\"summary\">&#8211; Lazy redirection for a squeeze page&#8217;s form<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_lazy_squeeze\/\">oiksp_lazy_squeeze() <span class=\"summary\">&#8211; Display the squeeze page or not<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_loaded\/\">oiksp_loaded() <span class=\"summary\">&#8211; Function to invoke when oik-squeeze is loaded<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_madmimi_admin\/\">oiksp_madmimi_admin() <span class=\"summary\">&#8211; Display the menu for MadMimi settings\n&quot;bw_madmimi&quot;<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_madmimi_default\/\">oiksp_madmimi_default() <span class=\"summary\">&#8211;<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_madmimi_do_page\/\">oiksp_madmimi_do_page() <span class=\"summary\">&#8211; Mad Mimi settings<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_madmimi_options\/\">oiksp_madmimi_options() <span class=\"summary\">&#8211;<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_madmimi_usage\/\">oiksp_madmimi_usage() <span class=\"summary\">&#8211; Some basic instructions for setting up Mad Mimi\nNo logic to test yet!\nWe could do this easily enough by pretending to add someone and using &quot;oiksp_confirmed_contact_madmimi()&quot;<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_mailpoet_default\/\">oiksp_mailpoet_default() <span class=\"summary\">&#8211;<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_newsletters\/\">oiksp_newsletters() <span class=\"summary\">&#8211; Determine the 3rd party newsletter software to integrate with<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_newsletters_filter\/\">oiksp_newsletters_filter() <span class=\"summary\">&#8211; We need to find a better way of detecting which Newsletters are available.<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_post_link\/\">oiksp_post_link() <span class=\"summary\">&#8211; Display a link to a post<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_privacy_policy_link\/\">oiksp_privacy_policy_link() <span class=\"summary\">&#8211; Display a link to the privacy policy<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_process_squeeze_form\/\">oiksp_process_squeeze_form() <span class=\"summary\">&#8211; Process the signup form for the squeeze page<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_redirect\/\">oiksp_redirect() <span class=\"summary\">&#8211; Redirect to the opted-in page passing the required values<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_redirect_check\/\">oiksp_redirect_check() <span class=\"summary\">&#8211; Implement &quot;template_redirect&quot; action for oik-squeeze<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_register_contacts\/\">oiksp_register_contacts() <span class=\"summary\">&#8211; &quot;oik_contact&quot; custom post type<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_register_optedinpage\/\">oiksp_register_optedinpage() <span class=\"summary\">&#8211; Register the &quot;opted_in&quot; custom post type<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_replace_fields\/\">oiksp_replace_fields() <span class=\"summary\">&#8211; Perform symbolic substitution of the fields in the body<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_require_confirmation\/\">oiksp_require_confirmation() <span class=\"summary\">&#8211; Update the oik-contact to requiring confirmation<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_send_email\/\">oiksp_send_email() <span class=\"summary\">&#8211; Build and send an email with fields substituted by default<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_send_optin_email\/\">oiksp_send_optin_email() <span class=\"summary\">&#8211; Send the opt-in email<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_set_current_user\/\">oiksp_set_current_user() <span class=\"summary\">&#8211; Set the user to the admin user so that we can access private data<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_signup_header\/\">oiksp_signup_header() <span class=\"summary\">&#8211; Implement &quot;signup_header&quot; action for oik-squeeze<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_squeeze_do_page\/\">oiksp_squeeze_do_page() <span class=\"summary\">&#8211; Opted-in settings<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_squeeze_is_active\/\">oiksp_squeeze_is_active() <span class=\"summary\">&#8211; Check if the &#091;bw_squeeze] shortcode is active<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_squeeze_options\/\">oiksp_squeeze_options() <span class=\"summary\">&#8211; Display the opted-in settings<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_squeeze_usage\/\">oiksp_squeeze_usage() <span class=\"summary\">&#8211; Give an example of a squeeze page<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_statuses\/\">oiksp_statuses() <span class=\"summary\">&#8211; Return a list of &quot;Contacts&quot; statuses<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_the_content\/\">oiksp_the_content() <span class=\"summary\">&#8211; Implement &quot;the_content&quot; filter for the &quot;opted_in&quot; custom post type<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_update_confirm\/\">oiksp_update_confirm() <span class=\"summary\">&#8211;<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_update_status\/\">oiksp_update_status() <span class=\"summary\">&#8211; Update the Contact&#8217;s status<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_validate_contact\/\">oiksp_validate_contact() <span class=\"summary\">&#8211; Validate the contact information with respect to the contact status<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_validate_double\/\">oiksp_validate_double() <span class=\"summary\">&#8211; If the opted-in page requires double opt-in then we need to validate the confirm field as well\nWe should only need to do this when we are on the opted-in page<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_validate_fields\/\">oiksp_validate_fields() <span class=\"summary\">&#8211; Validate the fields on the form<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_validate_name\/\">oiksp_validate_name() <span class=\"summary\">&#8211; Return a validated name field<\/span><\/a><\/li><li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oik_squeeze_activation\/\">oik_squeeze_activation() <span class=\"summary\">&#8211; Implement &quot;admin_notices&quot; filter for oik-squeeze<\/span><\/a><\/li><\/ul>","protected":false},"excerpt":{"rendered":"<p>Application Programming Interfaces for the <span class=\"bw_plug\"><a class=\"plugin\" href=\"https:\/\/www.oik-plugins.com\/oik-plugins\/oik-squeeze\/\" title=\"Link to the oik-squeeze (oik-squeeze: squeeze page WordPress plugin) plugin\">oik-squeeze<\/a><\/span> plugin:<\/p>\n<ul class=\"bw_list\">\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/bw_form_field__oiksp_message\/\">bw_form_field__oiksp_message() <span class=\"summary\">&#8211; Format the &quot;_oiksp_message&quot; field &#8211; setting a default if required<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/bw_squeeze\/\">bw_squeeze() <span class=\"summary\">&#8211; Implement the &#091;bw_squeeze] shortcode<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/bw_squeeze_form\/\">bw_squeeze_form() <span class=\"summary\">&#8211; Handle the squeeze form or popup<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksc_ajax_nopriv_oiksp_form\/\">oiksc_ajax_nopriv_oiksp_form() <span class=\"summary\">&#8211; Implement &quot;wp_ajax_nopriv_oiksp_form&quot; action to display the squeeze page opt-in form for visitors<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_admin_menu\/\">oiksp_admin_menu() <span class=\"summary\">&#8211; Implement &quot;oik_admin_menu&quot; for oik-squeeze<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_ajax_oiksp_form\/\">oiksp_ajax_oiksp_form() <span class=\"summary\">&#8211; Implement &quot;wp_ajax_oiksp_form&quot; action to display the squeeze page opt-in form<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_build_redirect\/\">oiksp_build_redirect() <span class=\"summary\">&#8211; Return the correct link for the opted-in page for this user<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_check_authority\/\">oiksp_check_authority() <span class=\"summary\">&#8211; Check overriding authority to view this opted-in page<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_check_confirm\/\">oiksp_check_confirm() <span class=\"summary\">&#8211; Check the confirm value against the one registered<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_check_contact\/\">oiksp_check_contact() <span class=\"summary\">&#8211; Check that the contact is valid and matches the name and (when required) confirm field<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_check_name\/\">oiksp_check_name() <span class=\"summary\">&#8211; Check the name given against the one registered<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_check_status\/\">oiksp_check_status() <span class=\"summary\">&#8211; Check the status of the oik_contact record for the opt-in requirements of the opted-in page<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_confirmed_contact\/\">oiksp_confirmed_contact() <span class=\"summary\">&#8211; Let the 3rd party email system know about the contact<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_confirmed_contact_madmimi\/\">oiksp_confirmed_contact_madmimi() <span class=\"summary\">&#8211; Perform the &quot;oiksp_confirmed_contact&quot; action for a MadMimi mailing list<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_confirmed_contact_mailpoet\/\">oiksp_confirmed_contact_mailpoet() <span class=\"summary\">&#8211; Perform the &quot;oiksp_confirmed_contact&quot; action for a MailPoet mailing list<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_create_contact\/\">oiksp_create_contact() <span class=\"summary\">&#8211; Create the oik_contact record for the first contact<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_create_oik_contact\/\">oiksp_create_oik_contact() <span class=\"summary\">&#8211; Create an oik_contact record programmatically<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_default\/\">oiksp_default() <span class=\"summary\">&#8211; Return the default option value from the bw_squeeze profile<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_display_confirmation\/\">oiksp_display_confirmation() <span class=\"summary\">&#8211;<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_display_opted_in_excerpt\/\">oiksp_display_opted_in_excerpt() <span class=\"summary\">&#8211; Display the excerpt from the opted_in page<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_display_squeeze_form\/\">oiksp_display_squeeze_form() <span class=\"summary\">&#8211; Display the signup form for the squeeze page<br \/>\nThis version doesn&#8217;t let other plugins play **?**<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_display_squeeze_popup\/\">oiksp_display_squeeze_popup() <span class=\"summary\">&#8211; Display the squeeze page popup link<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_email_body_label\/\">oiksp_email_body_label() <span class=\"summary\">&#8211; Return email body label, showing an example<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_email_content_types\/\">oiksp_email_content_types() <span class=\"summary\">&#8211; Return the list of email content types<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_generate_confirm\/\">oiksp_generate_confirm() <span class=\"summary\">&#8211; Generate a 26 digit confirmation key for the double opt-in<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_get_contact\/\">oiksp_get_contact() <span class=\"summary\">&#8211; Load an oik_contact record by the email address<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_get_double\/\">oiksp_get_double() <span class=\"summary\">&#8211; Retrieve the double opt-in requirement of the opted-in page<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_get_email_default\/\">oiksp_get_email_default() <span class=\"summary\">&#8211; Return a default email message for double opt-in<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_get_email_headers\/\">oiksp_get_email_headers() <span class=\"summary\">&#8211; Set the email headers for the wp_mail() <span class=\"summary\">call<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_get_email_message\/\">oiksp_get_email_message() <span class=\"summary\">&#8211; Build the email message<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_get_email_subject\/\">oiksp_get_email_subject() <span class=\"summary\">&#8211; Return the subject of the email<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_get_status\/\">oiksp_get_status() <span class=\"summary\">&#8211;<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_init\/\">oiksp_init() <span class=\"summary\">&#8211; Implement &quot;oik_fields_loaded&quot; action for oik-squeeze<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_lazy_admin_menu\/\">oiksp_lazy_admin_menu() <span class=\"summary\">&#8211; Display the menu for squeeze settings  ( &quot;bw_squeeze&quot; )<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_lazy_redirect\/\">oiksp_lazy_redirect() <span class=\"summary\">&#8211; Lazy redirection for a squeeze page&#8217;s form<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_lazy_squeeze\/\">oiksp_lazy_squeeze() <span class=\"summary\">&#8211; Display the squeeze page or not<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_loaded\/\">oiksp_loaded() <span class=\"summary\">&#8211; Function to invoke when oik-squeeze is loaded<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_madmimi_admin\/\">oiksp_madmimi_admin() <span class=\"summary\">&#8211; Display the menu for MadMimi settings<br \/>\n&quot;bw_madmimi&quot;<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_madmimi_default\/\">oiksp_madmimi_default() <span class=\"summary\">&#8211;<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_madmimi_do_page\/\">oiksp_madmimi_do_page() <span class=\"summary\">&#8211; Mad Mimi settings<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_madmimi_options\/\">oiksp_madmimi_options() <span class=\"summary\">&#8211;<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_madmimi_usage\/\">oiksp_madmimi_usage() <span class=\"summary\">&#8211; Some basic instructions for setting up Mad Mimi<br \/>\nNo logic to test yet!<br \/>\nWe could do this easily enough by pretending to add someone and using &quot;oiksp_confirmed_contact_madmimi()&quot;<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_mailpoet_default\/\">oiksp_mailpoet_default() <span class=\"summary\">&#8211;<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_newsletters\/\">oiksp_newsletters() <span class=\"summary\">&#8211; Determine the 3rd party newsletter software to integrate with<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_newsletters_filter\/\">oiksp_newsletters_filter() <span class=\"summary\">&#8211; We need to find a better way of detecting which Newsletters are available.<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_post_link\/\">oiksp_post_link() <span class=\"summary\">&#8211; Display a link to a post<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_privacy_policy_link\/\">oiksp_privacy_policy_link() <span class=\"summary\">&#8211; Display a link to the privacy policy<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_process_squeeze_form\/\">oiksp_process_squeeze_form() <span class=\"summary\">&#8211; Process the signup form for the squeeze page<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_redirect\/\">oiksp_redirect() <span class=\"summary\">&#8211; Redirect to the opted-in page passing the required values<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_redirect_check\/\">oiksp_redirect_check() <span class=\"summary\">&#8211; Implement &quot;template_redirect&quot; action for oik-squeeze<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_register_contacts\/\">oiksp_register_contacts() <span class=\"summary\">&#8211; &quot;oik_contact&quot; custom post type<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_register_optedinpage\/\">oiksp_register_optedinpage() <span class=\"summary\">&#8211; Register the &quot;opted_in&quot; custom post type<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_replace_fields\/\">oiksp_replace_fields() <span class=\"summary\">&#8211; Perform symbolic substitution of the fields in the body<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_require_confirmation\/\">oiksp_require_confirmation() <span class=\"summary\">&#8211; Update the oik-contact to requiring confirmation<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_send_email\/\">oiksp_send_email() <span class=\"summary\">&#8211; Build and send an email with fields substituted by default<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_send_optin_email\/\">oiksp_send_optin_email() <span class=\"summary\">&#8211; Send the opt-in email<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_set_current_user\/\">oiksp_set_current_user() <span class=\"summary\">&#8211; Set the user to the admin user so that we can access private data<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_signup_header\/\">oiksp_signup_header() <span class=\"summary\">&#8211; Implement &quot;signup_header&quot; action for oik-squeeze<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_squeeze_do_page\/\">oiksp_squeeze_do_page() <span class=\"summary\">&#8211; Opted-in settings<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_squeeze_is_active\/\">oiksp_squeeze_is_active() <span class=\"summary\">&#8211; Check if the &#091;bw_squeeze] shortcode is active<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_squeeze_options\/\">oiksp_squeeze_options() <span class=\"summary\">&#8211; Display the opted-in settings<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_squeeze_usage\/\">oiksp_squeeze_usage() <span class=\"summary\">&#8211; Give an example of a squeeze page<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_statuses\/\">oiksp_statuses() <span class=\"summary\">&#8211; Return a list of &quot;Contacts&quot; statuses<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_the_content\/\">oiksp_the_content() <span class=\"summary\">&#8211; Implement &quot;the_content&quot; filter for the &quot;opted_in&quot; custom post type<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_update_confirm\/\">oiksp_update_confirm() <span class=\"summary\">&#8211;<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_update_status\/\">oiksp_update_status() <span class=\"summary\">&#8211; Update the Contact&#8217;s status<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_validate_contact\/\">oiksp_validate_contact() <span class=\"summary\">&#8211; Validate the contact information with respect to the contact status<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_validate_double\/\">oiksp_validate_double() <span class=\"summary\">&#8211; If the opted-in page requires double opt-in then we need to validate the confirm field as well<br \/>\nWe should only need to do this when we are on the opted-in page<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_validate_fields\/\">oiksp_validate_fields() <span class=\"summary\">&#8211; Validate the fields on the form<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oiksp_validate_name\/\">oiksp_validate_name() <span class=\"summary\">&#8211; Return a validated name field<\/span><\/a><\/li>\n<li><a href=\"https:\/\/www.oik-plugins.com\/oik_api\/oik_squeeze_activation\/\">oik_squeeze_activation() <span class=\"summary\">&#8211; Implement &quot;admin_notices&quot; filter for oik-squeeze<\/span><\/a><\/li>\n<\/ul>\n","protected":false},"author":1,"featured_media":0,"parent":1771,"menu_order":0,"comment_status":"closed","ping_status":"open","template":"","meta":{"_acf_changed":false,"_genesis_hide_title":false,"_genesis_hide_breadcrumbs":false,"_genesis_hide_singular_image":false,"_genesis_hide_footer_widgets":false,"_genesis_custom_body_class":"","_genesis_custom_post_class":"","_genesis_layout":"","footnotes":""},"letters":[513],"class_list":{"0":"post-10123","1":"page","2":"type-page","3":"status-publish","5":"letters-o","6":"entry"},"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v26.0 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>oik-squeeze APIs - [oik] plugins.com<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.oik-plugins.com\/apis\/oik-squeeze-apis\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"oik-squeeze APIs - [oik] plugins.com\" \/>\n<meta property=\"og:description\" content=\"Application Programming Interfaces for the oik-squeeze plugin:  bw_form_field__oiksp_message() &#8211; Format the &quot;_oiksp_message&quot; field &#8211; setting a default if requiredbw_squeeze() &#8211; Implement the &#091;bw_squeeze] shortcodebw_squeeze_form() &#8211; Handle the squeeze form or popupoiksc_ajax_nopriv_oiksp_form() &#8211; Implement &quot;wp_ajax_nopriv_oiksp_form&quot; action to display the squeeze page opt-in form for visitorsoiksp_admin_menu() &#8211; Implement &quot;oik_admin_menu&quot; for oik-squeezeoiksp_ajax_oiksp_form() &#8211; Implement &quot;wp_ajax_oiksp_form&quot; action to display the squeeze page opt-in formoiksp_build_redirect() &#8211; Return the correct link for the opted-in page for this useroiksp_check_authority() &#8211; Check overriding authority to view this opted-in pageoiksp_check_confirm() &#8211; Check the confirm value against the one registeredoiksp_check_contact() &#8211; Check that the contact is valid and matches the name and (when required) confirm fieldoiksp_check_name() &#8211; Check the name given against the one registeredoiksp_check_status() &#8211; Check the status of the oik_contact record for the opt-in requirements of the opted-in pageoiksp_confirmed_contact() &#8211; Let the 3rd party email system know about the contactoiksp_confirmed_contact_madmimi() &#8211; Perform the &quot;oiksp_confirmed_contact&quot; action for a MadMimi mailing listoiksp_confirmed_contact_mailpoet() &#8211; Perform the &quot;oiksp_confirmed_contact&quot; action for a MailPoet mailing listoiksp_create_contact() &#8211; Create the oik_contact record for the first contactoiksp_create_oik_contact() &#8211; Create an oik_contact record programmaticallyoiksp_default() &#8211; Return the default option value from the bw_squeeze profileoiksp_display_confirmation() &#8211;oiksp_display_opted_in_excerpt() &#8211; Display the excerpt from the opted_in pageoiksp_display_squeeze_form() &#8211; Display the signup form for the squeeze page This version doesn&#8217;t let other plugins play **?**oiksp_display_squeeze_popup() &#8211; Display the squeeze page popup linkoiksp_email_body_label() &#8211; Return email body label, showing an exampleoiksp_email_content_types() &#8211; Return the list of email content typesoiksp_generate_confirm() &#8211; Generate a 26 digit confirmation key for the double opt-inoiksp_get_contact() &#8211; Load an oik_contact record by the email addressoiksp_get_double() &#8211; Retrieve the double opt-in requirement of the opted-in pageoiksp_get_email_default() &#8211; Return a default email message for double opt-inoiksp_get_email_headers() &#8211; Set the email headers for the wp_mail() calloiksp_get_email_message() &#8211; Build the email messageoiksp_get_email_subject() &#8211; Return the subject of the emailoiksp_get_status() &#8211;oiksp_init() &#8211; Implement &quot;oik_fields_loaded&quot; action for oik-squeezeoiksp_lazy_admin_menu() &#8211; Display the menu for squeeze settings ( &quot;bw_squeeze&quot; )oiksp_lazy_redirect() &#8211; Lazy redirection for a squeeze page&#8217;s formoiksp_lazy_squeeze() &#8211; Display the squeeze page or notoiksp_loaded() &#8211; Function to invoke when oik-squeeze is loadedoiksp_madmimi_admin() &#8211; Display the menu for MadMimi settings &quot;bw_madmimi&quot;oiksp_madmimi_default() &#8211;oiksp_madmimi_do_page() &#8211; Mad Mimi settingsoiksp_madmimi_options() &#8211;oiksp_madmimi_usage() &#8211; Some basic instructions for setting up Mad Mimi No logic to test yet! We could do this easily enough by pretending to add someone and using &quot;oiksp_confirmed_contact_madmimi()&quot;oiksp_mailpoet_default() &#8211;oiksp_newsletters() &#8211; Determine the 3rd party newsletter software to integrate withoiksp_newsletters_filter() &#8211; We need to find a better way of detecting which Newsletters are available.oiksp_post_link() &#8211; Display a link to a postoiksp_privacy_policy_link() &#8211; Display a link to the privacy policyoiksp_process_squeeze_form() &#8211; Process the signup form for the squeeze pageoiksp_redirect() &#8211; Redirect to the opted-in page passing the required valuesoiksp_redirect_check() &#8211; Implement &quot;template_redirect&quot; action for oik-squeezeoiksp_register_contacts() &#8211; &quot;oik_contact&quot; custom post typeoiksp_register_optedinpage() &#8211; Register the &quot;opted_in&quot; custom post typeoiksp_replace_fields() &#8211; Perform symbolic substitution of the fields in the bodyoiksp_require_confirmation() &#8211; Update the oik-contact to requiring confirmationoiksp_send_email() &#8211; Build and send an email with fields substituted by defaultoiksp_send_optin_email() &#8211; Send the opt-in emailoiksp_set_current_user() &#8211; Set the user to the admin user so that we can access private dataoiksp_signup_header() &#8211; Implement &quot;signup_header&quot; action for oik-squeezeoiksp_squeeze_do_page() &#8211; Opted-in settingsoiksp_squeeze_is_active() &#8211; Check if the &#091;bw_squeeze] shortcode is activeoiksp_squeeze_options() &#8211; Display the opted-in settingsoiksp_squeeze_usage() &#8211; Give an example of a squeeze pageoiksp_statuses() &#8211; Return a list of &quot;Contacts&quot; statusesoiksp_the_content() &#8211; Implement &quot;the_content&quot; filter for the &quot;opted_in&quot; custom post typeoiksp_update_confirm() &#8211;oiksp_update_status() &#8211; Update the Contact&#8217;s statusoiksp_validate_contact() &#8211; Validate the contact information with respect to the contact statusoiksp_validate_double() &#8211; If the opted-in page requires double opt-in then we need to validate the confirm field as well We should only need to do this when we are on the opted-in pageoiksp_validate_fields() &#8211; Validate the fields on the formoiksp_validate_name() &#8211; Return a validated name fieldoik_squeeze_activation() &#8211; Implement &quot;admin_notices&quot; filter for oik-squeeze\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.oik-plugins.com\/apis\/oik-squeeze-apis\/\" \/>\n<meta property=\"og:site_name\" content=\"[oik] plugins.com\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.oik-plugins.com\/apis\/oik-squeeze-apis\/\",\"url\":\"https:\/\/www.oik-plugins.com\/apis\/oik-squeeze-apis\/\",\"name\":\"oik-squeeze APIs - [oik] plugins.com\",\"isPartOf\":{\"@id\":\"https:\/\/www.oik-plugins.com\/#website\"},\"datePublished\":\"2013-12-02T16:34:12+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/www.oik-plugins.com\/apis\/oik-squeeze-apis\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.oik-plugins.com\/apis\/oik-squeeze-apis\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.oik-plugins.com\/apis\/oik-squeeze-apis\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"APIs\",\"item\":\"https:\/\/www.oik-plugins.com\/apis\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"oik-squeeze APIs\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.oik-plugins.com\/#website\",\"url\":\"https:\/\/www.oik-plugins.com\/\",\"name\":\"[oik] plugins.com\",\"description\":\"WordPress plugins and themes\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/www.oik-plugins.com\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"oik-squeeze APIs - [oik] plugins.com","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.oik-plugins.com\/apis\/oik-squeeze-apis\/","og_locale":"en_US","og_type":"article","og_title":"oik-squeeze APIs - [oik] plugins.com","og_description":"Application Programming Interfaces for the oik-squeeze plugin:  bw_form_field__oiksp_message() &#8211; Format the &quot;_oiksp_message&quot; field &#8211; setting a default if requiredbw_squeeze() &#8211; Implement the &#091;bw_squeeze] shortcodebw_squeeze_form() &#8211; Handle the squeeze form or popupoiksc_ajax_nopriv_oiksp_form() &#8211; Implement &quot;wp_ajax_nopriv_oiksp_form&quot; action to display the squeeze page opt-in form for visitorsoiksp_admin_menu() &#8211; Implement &quot;oik_admin_menu&quot; for oik-squeezeoiksp_ajax_oiksp_form() &#8211; Implement &quot;wp_ajax_oiksp_form&quot; action to display the squeeze page opt-in formoiksp_build_redirect() &#8211; Return the correct link for the opted-in page for this useroiksp_check_authority() &#8211; Check overriding authority to view this opted-in pageoiksp_check_confirm() &#8211; Check the confirm value against the one registeredoiksp_check_contact() &#8211; Check that the contact is valid and matches the name and (when required) confirm fieldoiksp_check_name() &#8211; Check the name given against the one registeredoiksp_check_status() &#8211; Check the status of the oik_contact record for the opt-in requirements of the opted-in pageoiksp_confirmed_contact() &#8211; Let the 3rd party email system know about the contactoiksp_confirmed_contact_madmimi() &#8211; Perform the &quot;oiksp_confirmed_contact&quot; action for a MadMimi mailing listoiksp_confirmed_contact_mailpoet() &#8211; Perform the &quot;oiksp_confirmed_contact&quot; action for a MailPoet mailing listoiksp_create_contact() &#8211; Create the oik_contact record for the first contactoiksp_create_oik_contact() &#8211; Create an oik_contact record programmaticallyoiksp_default() &#8211; Return the default option value from the bw_squeeze profileoiksp_display_confirmation() &#8211;oiksp_display_opted_in_excerpt() &#8211; Display the excerpt from the opted_in pageoiksp_display_squeeze_form() &#8211; Display the signup form for the squeeze page This version doesn&#8217;t let other plugins play **?**oiksp_display_squeeze_popup() &#8211; Display the squeeze page popup linkoiksp_email_body_label() &#8211; Return email body label, showing an exampleoiksp_email_content_types() &#8211; Return the list of email content typesoiksp_generate_confirm() &#8211; Generate a 26 digit confirmation key for the double opt-inoiksp_get_contact() &#8211; Load an oik_contact record by the email addressoiksp_get_double() &#8211; Retrieve the double opt-in requirement of the opted-in pageoiksp_get_email_default() &#8211; Return a default email message for double opt-inoiksp_get_email_headers() &#8211; Set the email headers for the wp_mail() calloiksp_get_email_message() &#8211; Build the email messageoiksp_get_email_subject() &#8211; Return the subject of the emailoiksp_get_status() &#8211;oiksp_init() &#8211; Implement &quot;oik_fields_loaded&quot; action for oik-squeezeoiksp_lazy_admin_menu() &#8211; Display the menu for squeeze settings ( &quot;bw_squeeze&quot; )oiksp_lazy_redirect() &#8211; Lazy redirection for a squeeze page&#8217;s formoiksp_lazy_squeeze() &#8211; Display the squeeze page or notoiksp_loaded() &#8211; Function to invoke when oik-squeeze is loadedoiksp_madmimi_admin() &#8211; Display the menu for MadMimi settings &quot;bw_madmimi&quot;oiksp_madmimi_default() &#8211;oiksp_madmimi_do_page() &#8211; Mad Mimi settingsoiksp_madmimi_options() &#8211;oiksp_madmimi_usage() &#8211; Some basic instructions for setting up Mad Mimi No logic to test yet! We could do this easily enough by pretending to add someone and using &quot;oiksp_confirmed_contact_madmimi()&quot;oiksp_mailpoet_default() &#8211;oiksp_newsletters() &#8211; Determine the 3rd party newsletter software to integrate withoiksp_newsletters_filter() &#8211; We need to find a better way of detecting which Newsletters are available.oiksp_post_link() &#8211; Display a link to a postoiksp_privacy_policy_link() &#8211; Display a link to the privacy policyoiksp_process_squeeze_form() &#8211; Process the signup form for the squeeze pageoiksp_redirect() &#8211; Redirect to the opted-in page passing the required valuesoiksp_redirect_check() &#8211; Implement &quot;template_redirect&quot; action for oik-squeezeoiksp_register_contacts() &#8211; &quot;oik_contact&quot; custom post typeoiksp_register_optedinpage() &#8211; Register the &quot;opted_in&quot; custom post typeoiksp_replace_fields() &#8211; Perform symbolic substitution of the fields in the bodyoiksp_require_confirmation() &#8211; Update the oik-contact to requiring confirmationoiksp_send_email() &#8211; Build and send an email with fields substituted by defaultoiksp_send_optin_email() &#8211; Send the opt-in emailoiksp_set_current_user() &#8211; Set the user to the admin user so that we can access private dataoiksp_signup_header() &#8211; Implement &quot;signup_header&quot; action for oik-squeezeoiksp_squeeze_do_page() &#8211; Opted-in settingsoiksp_squeeze_is_active() &#8211; Check if the &#091;bw_squeeze] shortcode is activeoiksp_squeeze_options() &#8211; Display the opted-in settingsoiksp_squeeze_usage() &#8211; Give an example of a squeeze pageoiksp_statuses() &#8211; Return a list of &quot;Contacts&quot; statusesoiksp_the_content() &#8211; Implement &quot;the_content&quot; filter for the &quot;opted_in&quot; custom post typeoiksp_update_confirm() &#8211;oiksp_update_status() &#8211; Update the Contact&#8217;s statusoiksp_validate_contact() &#8211; Validate the contact information with respect to the contact statusoiksp_validate_double() &#8211; If the opted-in page requires double opt-in then we need to validate the confirm field as well We should only need to do this when we are on the opted-in pageoiksp_validate_fields() &#8211; Validate the fields on the formoiksp_validate_name() &#8211; Return a validated name fieldoik_squeeze_activation() &#8211; Implement &quot;admin_notices&quot; filter for oik-squeeze","og_url":"https:\/\/www.oik-plugins.com\/apis\/oik-squeeze-apis\/","og_site_name":"[oik] plugins.com","schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/www.oik-plugins.com\/apis\/oik-squeeze-apis\/","url":"https:\/\/www.oik-plugins.com\/apis\/oik-squeeze-apis\/","name":"oik-squeeze APIs - [oik] plugins.com","isPartOf":{"@id":"https:\/\/www.oik-plugins.com\/#website"},"datePublished":"2013-12-02T16:34:12+00:00","breadcrumb":{"@id":"https:\/\/www.oik-plugins.com\/apis\/oik-squeeze-apis\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.oik-plugins.com\/apis\/oik-squeeze-apis\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.oik-plugins.com\/apis\/oik-squeeze-apis\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"APIs","item":"https:\/\/www.oik-plugins.com\/apis\/"},{"@type":"ListItem","position":2,"name":"oik-squeeze APIs"}]},{"@type":"WebSite","@id":"https:\/\/www.oik-plugins.com\/#website","url":"https:\/\/www.oik-plugins.com\/","name":"[oik] plugins.com","description":"WordPress plugins and themes","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.oik-plugins.com\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"}]}},"_links":{"self":[{"href":"https:\/\/www.oik-plugins.com\/wp-json\/wp\/v2\/pages\/10123","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.oik-plugins.com\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.oik-plugins.com\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.oik-plugins.com\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.oik-plugins.com\/wp-json\/wp\/v2\/comments?post=10123"}],"version-history":[{"count":1,"href":"https:\/\/www.oik-plugins.com\/wp-json\/wp\/v2\/pages\/10123\/revisions"}],"predecessor-version":[{"id":10124,"href":"https:\/\/www.oik-plugins.com\/wp-json\/wp\/v2\/pages\/10123\/revisions\/10124"}],"up":[{"embeddable":true,"href":"https:\/\/www.oik-plugins.com\/wp-json\/wp\/v2\/pages\/1771"}],"wp:attachment":[{"href":"https:\/\/www.oik-plugins.com\/wp-json\/wp\/v2\/media?parent=10123"}],"wp:term":[{"taxonomy":"letters","embeddable":true,"href":"https:\/\/www.oik-plugins.com\/wp-json\/wp\/v2\/letters?post=10123"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}