' . esc_html__('Newsletter subscription consent (listmonk):', 'integration-for-listmonk') . ' ' . esc_html($display_value) . '
'; 183 | } 184 | 185 | // end of the code to add newsletter checkbox to checkout 186 | 187 | // required for encrypting the listmonk password 188 | require_once plugin_dir_path( __FILE__ ) . 'includes/fsd-data-encryption.php'; 189 | 190 | ## get user ip 191 | function listmonk_get_the_user_ip() { 192 | if ( ! empty( $_SERVER['HTTP_CLIENT_IP'] ) ) { 193 | //check ip from share internet 194 | $ip = sanitize_text_field(wp_unslash($_SERVER['HTTP_CLIENT_IP'])); 195 | } elseif ( ! empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) { 196 | //to check ip is passed from proxy 197 | $ip = sanitize_text_field(wp_unslash($_SERVER['HTTP_X_FORWARDED_FOR'])); // get ip address of user 198 | } else { 199 | $ip = sanitize_text_field(wp_unslash($_SERVER['REMOTE_ADDR'])); // get ip address of user 200 | } 201 | return ($ip); // return ip address 202 | } 203 | 204 | // check if listmonk credentials are configured 205 | function listmonk_are_listmonk_settings_configured() { 206 | $listmonk_url = sanitize_text_field(get_option('listmonk_url')); // get listmonk url from settings page 207 | $listmonk_username = sanitize_text_field(get_option('listmonk_username')); // get listmonk username from settings page 208 | $listmonk_password = sanitize_text_field(get_option('listmonk_password')); // get listmonk password from settings page 209 | 210 | return !empty($listmonk_url) && !empty($listmonk_username) && !empty($listmonk_password); // return true if all settings are configured 211 | } 212 | 213 | ## function to send data to listmonk through WordPress HTTP API 214 | function listmonk_send_data_to_listmonk_wordpress_http_api($url, $body, $username, $password) { 215 | // Sanitize the URL 216 | $url = esc_url_raw(filter_var($url, FILTER_VALIDATE_URL)); 217 | 218 | // Prepare the headers 219 | $headers = array( 220 | 'Authorization' => 'Basic ' . base64_encode($username . ':' . $password), 221 | 'Content-Type' => 'application/json', 222 | ); 223 | 224 | // Setup the body and headers 225 | $args = array( 226 | 'body' => json_encode($body), 227 | 'headers' => $headers, 228 | 'method' => 'POST' 229 | ); 230 | 231 | // Make the request 232 | $response = wp_remote_post($url, $args); 233 | 234 | // Check for error in response 235 | if (is_wp_error($response)) { 236 | error_log('Listmonk API error: ' . $response->get_error_message()); 237 | return [ 238 | 'status_code' => wp_remote_retrieve_response_code($response), 239 | 'body' => wp_remote_retrieve_body($response), 240 | 'error_message' => 'Listmonk API error: ' . $response->get_error_message() 241 | 242 | ]; 243 | } 244 | 245 | $httpCode = wp_remote_retrieve_response_code($response); 246 | $body = wp_remote_retrieve_body($response); 247 | $errorMessage = ''; 248 | 249 | // Handling different HTTP error codes 250 | switch ($httpCode) { 251 | case 400: 252 | error_log('Listmonk API error: Missing or bad request parameters or values'); 253 | break; 254 | case 403: 255 | error_log('Listmonk API error: Session expired or invalidate. Must relogin'); 256 | break; 257 | case 404: 258 | error_log('Listmonk API error: Request resource was not found'); 259 | break; 260 | case 405: 261 | error_log('Listmonk API error: Request method is not allowed on the requested endpoint'); 262 | break; 263 | case 410: 264 | error_log('Listmonk API error: The requested resource is gone permanently'); 265 | break; 266 | case 429: 267 | error_log('Listmonk API error: Too many requests to the API (rate limiting)'); 268 | break; 269 | case 500: 270 | error_log('Listmonk API error: Something unexpected went wrong'); 271 | break; 272 | case 502: 273 | error_log('Listmonk API error: The backend OMS is down and the API is unable to communicate with it'); 274 | break; 275 | case 503: 276 | error_log('Listmonk API error: Service unavailable; the API is down'); 277 | break; 278 | case 504: 279 | error_log('Listmonk API error: Gateway timeout; the API is unreachable'); 280 | break; 281 | default: 282 | if ($httpCode >= 400) { 283 | // Generic error for other 4xx and 5xx HTTP codes 284 | error_log("Listmonk API error (HTTP code $httpCode): " . json_decode($body)->message); 285 | $errorMessage = "Listmonk API error (HTTP code $httpCode): " . json_decode($body)->message; 286 | } 287 | } 288 | 289 | return [ 290 | 'status_code' => $httpCode, 291 | 'body' => json_decode($body, true), 292 | 'error_message' => $errorMessage 293 | ]; 294 | } 295 | 296 | // this function sends WPforms data to an external API (listmonk) through https 297 | function listmonk_send_data_through_wpforms( $fields, $entry, $form_data, $entry_id ) { 298 | if (!listmonk_are_listmonk_settings_configured()) { 299 | error_log("listmonk settings are not configured completely."); // Log an error message 300 | return; // Abort if settings are not configured 301 | } 302 | $listmonk_wpforms_form_id = absint(get_option('listmonk_wpforms_form_id')); // convert form id from option to integer 303 | $listmonk_wpforms_integration_on = sanitize_text_field(get_option('listmonk_wpforms_integration_on')); // check if the listmonk form option is disabled in settings 304 | 305 | // check if the form id matches the form id from the settings page and if the listmonk form option is enabled 306 | if (get_option('listmonk_wpforms_integration_on') != 'yes' || absint($form_data['id']) !== $listmonk_wpforms_form_id) { 307 | return; 308 | } 309 | 310 | // define variables 311 | $ip = listmonk_get_the_user_ip(); // define ip address of user, used for listmonk consent recording 312 | $website_name = sanitize_text_field(get_bloginfo( 'name' )); // Retrieves the website's name from the WordPress database 313 | $listmonk_list_id = absint(get_option('listmonk_list_id', 0)); // get listmonk list id from settings page 314 | 315 | //these attributes are used by listmonk as extra data for each subscriber. can be changed to your liking 316 | $attributes = [ 317 | 'subscription_origin' => 'website form', // this is the origin of the subscription, as opposed to payment 318 | 'confirmed_consent' => 'true', // user gave consent to receive newsletter 319 | 'ip_address' => $ip, // ip address of user 320 | 'consent_agreement' => 'I consent to receiving periodic newsletters from ' . $website_name . '.', // Use the website name dynamically 321 | ] ; 322 | 323 | // remove email from name field input 324 | $pattern = '/[^@\s]*@[^@\s]*\.[^@\s]*/'; // to avoid spam 325 | $replacement = '[removed]'; 326 | 327 | // sanitize name input 328 | $name = sanitize_text_field(wp_strip_all_tags($fields['1']['value'])); // get name from form; this assumes it is the first field in the form 329 | $name_email_stripped = preg_replace($pattern, $replacement, $name); // remove email from name field input 330 | $name_stripped_all = preg_replace('/[a-zA-Z]*[:\/\/]*[A-Za-z0-9\-_]+\.+[A-Za-z0-9\.\/%&=\?\-_]+/i', $replacement, $name_email_stripped); // remove urls from name field input 331 | 332 | // this body will be sent to listmonk 333 | $body = array( 334 | 'name' => $name_stripped_all, // get name from form 335 | 'email' => sanitize_email($fields['2']['value']), // get email from form, this assumes it is the second field in the form 336 | 'status' => 'enabled', // set to enabled to subscribe user 337 | 'lists' => [(int)$listmonk_list_id], // convert list id to integer 338 | 'preconfirm_subscriptions' => false, // set to true if you want to send a confirmation email to the user 339 | 'attribs' => $attributes, 340 | ); 341 | 342 | #listmonk credentials 343 | $listmonk_url = esc_url_raw(get_option('listmonk_url')); 344 | $listmonk_username = sanitize_text_field(get_option('listmonk_username')); 345 | 346 | ## password decryption 347 | $encryption = new listmonk_FSD_Data_Encryption(); 348 | $encrypted_password = sanitize_text_field(get_option('listmonk_password')); 349 | $listmonk_password = $encryption->decrypt($encrypted_password); 350 | 351 | // append the url from the settings page with the correct API endpoint 352 | $url = $listmonk_url . '/api/subscribers'; 353 | 354 | // using the send_data_to_listmonk function we defined earlier, we communicate with the listmonk API through WordPress HTTP API 355 | listmonk_send_data_to_listmonk_wordpress_http_api($url, $body, $listmonk_username, $listmonk_password); 356 | 357 | } 358 | add_action( 'wpforms_process_complete', 'listmonk_send_data_through_wpforms', 10, 4 ); 359 | 360 | /** EXPERIMENTAL CODE */ 361 | 362 | function listmonk_send_data_through_contact_form_7( $contact_form, $abort, $submission ) { 363 | if (!listmonk_are_listmonk_settings_configured()) { 364 | error_log("listmonk settings are not configured completely."); // Log an error message 365 | return; // Abort if settings are not configured 366 | } 367 | $listmonk_cf7_form_id = absint(get_option('listmonk_cf7_form_id')); // convert form id from option to integer 368 | $listmonk_cf7_integration_on = sanitize_text_field(get_option('listmonk_cf7_integration_on')); // check if the listmonk form option is disabled in settings 369 | 370 | // check if the form id matches the form id from the settings page and if the listmonk form option is enabled 371 | if (get_option('listmonk_cf7_integration_on') != 'yes' || absint($contact_form->id()) !== $listmonk_cf7_form_id) { 372 | if(get_option('listmonk_debug') == 'yes'){ 373 | error_log('CF7 integration not enabled or id doesnt match'); 374 | error_log('Current page ID: ' . absint($contact_form->id()) .''); 375 | error_log('CF7 page ID from listmonk settings: ' . $listmonk_cf7_form_id . ''); 376 | } 377 | return; 378 | }else{ 379 | if(get_option('listmonk_debug') == 'yes'){ 380 | error_log('Current page ID: ' . absint($contact_form->id()) .''); 381 | error_log('CF7 page ID from listmonk settings: ' . $listmonk_cf7_form_id . ''); 382 | } 383 | } 384 | 385 | $posted_data = $submission->get_posted_data(); 386 | $ip = listmonk_get_the_user_ip(); // define ip address of user, used for listmonk consent recording 387 | 388 | // Retrieve specific field data 389 | $email = isset($posted_data['your-email']) ? sanitize_email($posted_data['your-email']) : ''; 390 | $name = isset($posted_data['your-name']) ? sanitize_text_field($posted_data['your-name']) : ''; 391 | 392 | // Add your logic here to send data to listmonk 393 | 394 | // retrieve data to send to listmonk 395 | $website_name = sanitize_text_field(get_bloginfo( 'name' )); // Retrieves the website's name from the WordPress database 396 | $listmonk_list_id = absint(get_option('listmonk_list_id', 0)); // get listmonk list id from settings page 397 | if(get_option('listmonk_debug') == 'yes'){ 398 | error_log('Listmonk list ID : ' . $listmonk_list_id . ''); 399 | } 400 | ## for listmonk 401 | $attributes = [ 402 | 'subscription_origin' => 'Contact Form 7', 403 | 'confirmed_consent' => true, // user gave consent to receive newsletter 404 | 'ip_address' => $ip, // ip address of user 405 | 'consent_agreement' => 'I consent to receiving periodic newsletters from ' . $website_name . '.', // Use the website name dynamically 406 | ] ; 407 | 408 | // remove email from name field input 409 | $pattern = '/[^@\s]*@[^@\s]*\.[^@\s]*/'; // to avoid spam 410 | $replacement = '[removed]'; 411 | 412 | // sanitize name input 413 | $name = sanitize_text_field(strip_tags($name)); // get name from form; this assumes it is the first field in the form 414 | $name_email_stripped = preg_replace($pattern, $replacement, $name); // remove email from name field input 415 | $name_stripped_all = preg_replace('/[a-zA-Z]*[:\/\/]*[A-Za-z0-9\-_]+\.+[A-Za-z0-9\.\/%&=\?\-_]+/i', $replacement, $name_email_stripped); // remove urls from name field input 416 | 417 | // body to send with POST to the API 418 | $body = array( 419 | 'name' => $name_stripped_all, 420 | 'email' => $email, 421 | 'status' => 'enabled', 422 | 'lists' => [(int)$listmonk_list_id], 423 | 'attribs' => $attributes, 424 | 'preconfirm_subscriptions' => false, // set presubscription to false, because anyone can enter an email here 425 | ) ; 426 | 427 | #listmonk credentials 428 | $listmonk_url = esc_url_raw(get_option('listmonk_url')); 429 | $listmonk_username = sanitize_text_field(get_option('listmonk_username')); 430 | 431 | ## password decryption using the fsd-data-encryption class 432 | $encryption = new listmonk_FSD_Data_Encryption(); 433 | $encrypted_password = sanitize_text_field(get_option('listmonk_password')); 434 | $listmonk_password = $encryption->decrypt($encrypted_password); 435 | 436 | // append the url from the settings page 437 | $url = $listmonk_url . '/api/subscribers'; 438 | 439 | // using the send_data_to_listmonk function we defined earlier, we communicate with the listmonk API through WordPress HTTP API 440 | 441 | $response = listmonk_send_data_to_listmonk_wordpress_http_api($url, $body, $listmonk_username, $listmonk_password); 442 | 443 | // Optionally skip sending the email 444 | // add_filter('wpcf7_skip_mail', function() { return true; }); 445 | 446 | return $contact_form; 447 | } 448 | add_filter( 'wpcf7_before_send_mail', 'listmonk_send_data_through_contact_form_7', 10, 3 ); 449 | 450 | /** END OF EXPERIMENTAL CODE */ 451 | 452 | ## send subscriber data to listmonk after paying 453 | 454 | add_action( 'woocommerce_thankyou', 'listmonk_send_data_afer_checkout', 10, 1 ); 455 | function listmonk_send_data_afer_checkout( $order_id ){ 456 | // check ff the listmonk checkout component is enabled in settings 457 | if (get_option('listmonk_checkout_on') != 'yes') { 458 | return; 459 | } 460 | if( ! $order_id ){ // if order id is not set, return 461 | return; 462 | } 463 | 464 | if (!listmonk_are_listmonk_settings_configured()) { 465 | error_log("listmonk settings are not configured completely."); 466 | return; // Abort if settings are not configured 467 | } 468 | 469 | $order = wc_get_order( absint($order_id) ); // Get an instance of the WC_Order Object 470 | $additional_fields = $order->get_meta('_additional_fields', true); 471 | 472 | // check for user newsletter consent 473 | // $field_name = 'newsletter_optin'; // change this field to the name of your custom field for storing user consent in a checkbox 474 | $subscribed = ''; 475 | 476 | if (listmonk_is_checkout_block_enabled()) { 477 | $subscribed = $order->get_meta('_wc_other/listmonk/newsletter_optin', true); 478 | 479 | if (isset($subscribed) == false) { 480 | $subscribed = false; 481 | } 482 | } else { 483 | if (is_array($additional_fields) && isset($additional_fields['listmonk/newsletter_optin'])) { 484 | $subscribed = $additional_fields['listmonk/newsletter_optin']; 485 | if(get_option('listmonk_debug') == 'yes'){ 486 | error_log($subscribed); 487 | } 488 | } elseif ($order->get_meta('listmonk_newsletter_optin') !== '' && $order->get_meta('listmonk_newsletter_optin') !== false) { 489 | $subscribed = $order->get_meta('listmonk_newsletter_optin'); 490 | if(get_option('listmonk_debug') == 'yes'){ 491 | error_log($subscribed); 492 | } 493 | }else{ 494 | $subscribed == false; 495 | } 496 | } 497 | 498 | 499 | if ($subscribed != 'true' && $subscribed != '1') { // if user did not give consent, return 500 | return; 501 | } 502 | 503 | // get user info from the woocommerce order API 504 | $email = sanitize_email($order->get_billing_email()); // Get Customer billing email 505 | $name = sanitize_text_field($order->get_billing_first_name()); // Get Customer billing first name 506 | $country = $order->get_billing_country(); // Get Customer billing country 507 | $ip = $order->get_customer_ip_address(); // Get Customer ip address 508 | $website_name = sanitize_text_field(get_bloginfo( 'name' )); // Retrieves the website's name from the WordPress database 509 | 510 | $listmonk_list_id = absint(get_option('listmonk_list_id', 0)); // get listmonk list id from settings page 511 | 512 | ## for listmonk 513 | $attributes = [ 514 | 'country' => $country, 515 | 'subscription_origin' => 'payment', 516 | 'ip_address' => $ip, 517 | 'confirmed_consent' => true, // user gave consent to receive newsletter 518 | 'consent_agreement' => 'I consent to receiving periodic newsletters from ' . $website_name . '.', // Use the website name dynamically 519 | ] ; 520 | 521 | // body to send with POST to the API 522 | $body = array( 523 | 'name' => $name, 524 | 'email' => $email, 525 | 'status' => 'enabled', 526 | #'lists' => [2], 527 | 'lists' => [(int)$listmonk_list_id], 528 | 'attribs' => $attributes, 529 | 'preconfirm_subscriptions' => true, 530 | ) ; 531 | 532 | #listmonk credentials 533 | $listmonk_url = esc_url_raw(get_option('listmonk_url')); 534 | $listmonk_username = sanitize_text_field(get_option('listmonk_username')); 535 | 536 | ## password decryption using the fsd-data-encryption class 537 | $encryption = new listmonk_FSD_Data_Encryption(); 538 | $encrypted_password = sanitize_text_field(get_option('listmonk_password')); 539 | $listmonk_password = $encryption->decrypt($encrypted_password); 540 | 541 | // append the url from the settings page 542 | $url = $listmonk_url . '/api/subscribers'; 543 | 544 | // using the send_data_to_listmonk function we defined earlier, we communicate with the listmonk API through WordPress HTTP API 545 | 546 | $response = listmonk_send_data_to_listmonk_wordpress_http_api($url, $body, $listmonk_username, $listmonk_password); 547 | 548 | if ($response['status_code'] == 200) { 549 | $order->add_order_note('Customer subscribed to listmonk mailing list (ID = ' . $listmonk_list_id . ').'); 550 | }elseif($response['status_code'] == 409) { 551 | $order->add_order_note('Listmonk: Email address already exists in listmonk mailing list ' . $listmonk_list_id . ', customer had already subscribed.'); 552 | }else{ 553 | $order->add_order_note($response['error_message']); 554 | } 555 | 556 | } 557 | 558 | ### SETTINGS PAGE ### 559 | 560 | // Add a top-level menu for the plugin settings in the admin dashboard 561 | add_action('admin_menu', 'listmonk_top_lvl_menu'); 562 | function listmonk_top_lvl_menu(){ 563 | add_options_page( 564 | 'Settings - Integration for listmonk mailing list and newsletter manager', // Page title 565 | 'Integration for listmonk', // Menu title 566 | 'manage_options', // Capability required 567 | 'listmonk_integration', // Menu slug 568 | 'listmonk_integration_page_callback', // Function to display the settings page 569 | 4 // Position in the menu, 4 = right below 'Settings' 570 | ); 571 | } 572 | 573 | // Callback function to render the plugin settings page 574 | function listmonk_integration_page_callback(){ // Function to render the plugin settings page 575 | 576 | // Display warning if both conditions are met 577 | 578 | if(get_option('listmonk_cf7_integration_on') == 'yes') { 579 | echo '';
580 | echo '
';
582 | }
583 |
584 | ?>
585 | The listmonk integration with Contact Form 7 is still experimental. If you experience any problems, consider switching to a newsletter subscription form by WPForms. You can also file a bug report on Github.
'; 581 | echo '
586 |
587 |
594 |
595 |
596 |
597 | 
598 |
599 | encrypt(sanitize_text_field($input));
679 | return $encrypted_password;
680 | }
681 |
682 | // Initialize plugin settings
683 | add_action('admin_init', 'listmonk_settings_fields');
684 | function listmonk_settings_fields(){
685 | $page_slug = 'listmonk_integration'; // Slug of the settings page
686 | $option_group = 'listmonk_integration_settings'; // Option group for the settings fields
687 |
688 | // Add 'Plugin Components' section
689 | add_settings_section(
690 | 'listmonk_plugin_components', // Section ID
691 | 'Plugin Components', // Section title
692 | 'listmonk_plugin_components_description', // Callback for section description
693 | $page_slug // Page slug
694 | );
695 |
696 | // Add 'listmonk Credentials' section
697 | add_settings_section(
698 | 'listmonk_credentials', // Section ID
699 | 'listmonk Credentials', // Section title
700 | 'listmonk_credentials_description', // Callback for section description
701 | $page_slug // Page slug
702 | );
703 |
704 | // Add 'listmonk Credentials' section
705 | add_settings_section(
706 | 'listmonk_debug_section', // Section ID
707 | 'Debug mode', // Section title
708 | 'listmonk_debug_description', // Callback for section description
709 | $page_slug // Page slug
710 | );
711 |
712 | // Register and add settings fields
713 | register_setting($option_group, 'listmonk_checkout_on', 'listmonk_sanitize_checkbox');
714 | add_settings_field(
715 | 'listmonk_checkout_on', // Field ID
716 | 'Enable listmonk integration on WooCommerce Checkout:', // Field title
717 | 'listmonk_render_checkbox_field', // Callback for field markup
718 | $page_slug, // Page slug
719 | 'listmonk_plugin_components', // Section ID
720 | array('name' => 'listmonk_checkout_on') // Additional arguments for the callback function
721 | );
722 | // Register and add settings fields
723 | register_setting($option_group, 'listmonk_wpforms_integration_on', 'listmonk_sanitize_checkbox');
724 | add_settings_field(
725 | 'listmonk_wpforms_integration_on',
726 | 'Enable listmonk integration on a custom form using WPForms plugin:',
727 | 'listmonk_render_checkbox_field',
728 | $page_slug,
729 | 'listmonk_plugin_components',
730 | array('name' => 'listmonk_wpforms_integration_on')
731 | );
732 | // Register and add settings fields
733 | register_setting($option_group, 'listmonk_cf7_integration_on', 'listmonk_sanitize_checkbox');
734 | add_settings_field(
735 | 'listmonk_cf7_integration_on',
736 | 'Enable listmonk integration on a custom form using the Contact Form 7 plugin:',
737 | 'listmonk_render_checkbox_field',
738 | $page_slug,
739 | 'listmonk_plugin_components',
740 | array('name' => 'listmonk_cf7_integration_on')
741 | );
742 | // Register and add settings fields
743 | register_setting($option_group, 'listmonk_wpforms_form_id', 'listmonk_sanitize_list_id');
744 | add_settings_field(
745 | 'listmonk_wpforms_form_id',
746 | 'WPForms Form ID:',
747 | 'listmonk_render_wpforms_form_id_field',
748 | $page_slug,
749 | 'listmonk_plugin_components',
750 | array('name' => 'listmonk_wpforms_form_id')
751 | );
752 | // Register and add settings fields
753 | register_setting($option_group, 'listmonk_cf7_form_id', 'listmonk_sanitize_list_id');
754 | add_settings_field(
755 | 'listmonk_cf7_form_id',
756 | 'Contact Form 7 Page ID:',
757 | 'listmonk_render_cf7_form_id_field',
758 | $page_slug,
759 | 'listmonk_plugin_components',
760 | array('name' => 'listmonk_cf7_form_id')
761 | );
762 | // Register and add settings fields
763 | register_setting($option_group, 'listmonk_list_id', 'listmonk_sanitize_list_id');
764 | add_settings_field(
765 | 'listmonk_list_id',
766 | 'listmonk list ID:',
767 | 'listmonk_render_listmonk_list_id_field',
768 | $page_slug,
769 | 'listmonk_credentials',
770 | array('name' => 'listmonk_list_id')
771 | );
772 | // Register and add settings fields
773 | register_setting($option_group, 'listmonk_url', 'listmonk_sanitize_listmonk_url');
774 | add_settings_field(
775 | 'listmonk_url',
776 | 'listmonk URL:',
777 | 'listmonk_render_text_field',
778 | $page_slug,
779 | 'listmonk_credentials',
780 | array('name' => 'listmonk_url')
781 | );
782 | // Register and add settings fields
783 | register_setting($option_group, 'listmonk_username', 'sanitize_text_field');
784 | add_settings_field(
785 | 'listmonk_username',
786 | 'listmonk API username:',
787 | 'listmonk_render_text_field',
788 | $page_slug,
789 | 'listmonk_credentials',
790 | array('name' => 'listmonk_username')
791 | );
792 | // Register and add settings fields
793 | register_setting($option_group, 'listmonk_password', 'listmonk_sanitize_listmonk_password');
794 | add_settings_field(
795 | 'listmonk_password',
796 | 'listmonk API access token:',
797 | 'listmonk_render_text_field',
798 | $page_slug,
799 | 'listmonk_credentials',
800 | array('name' => 'listmonk_password')
801 | );
802 |
803 | // Register and add settings fields
804 | register_setting($option_group, 'listmonk_debug', 'listmonk_sanitize_checkbox');
805 | add_settings_field(
806 | 'listmonk_debug',
807 | 'Debug mode:',
808 | 'listmonk_render_checkbox_field',
809 | $page_slug,
810 | 'listmonk_debug_section',
811 | array('name' => 'listmonk_debug')
812 | );
813 |
814 | // Register and add settings fields for extra textbox
815 | register_setting($option_group, 'listmonk_optin_text', 'sanitize_text_field');
816 | add_settings_field(
817 | 'listmonk_optin_text', // Field ID
818 | 'WooCommerce checkout newsletter opt-in text:', // Field title
819 | 'listmonk_render_listmonk_optin_text', // Callback for field markup
820 | $page_slug, // Page slug
821 | 'listmonk_plugin_components', // Section ID
822 | array('name' => 'listmonk_optin_text') // Additional arguments for the callback function
823 | );
824 | }
825 |
826 | // Description for the 'Plugin Components' section
827 | function listmonk_plugin_components_description() { // Function to render the description for the 'Plugin Components' section
828 | echo 'Enjoying this free & open source plugin? Consider donating, so development can continue:
598 | ' . esc_html__('Integration for listmonk mailing list and newsletter manager can be enabled in three ways:', 'integration-for-listmonk') . '
'; 829 | echo '' . esc_html__('(1) On the WooCommerce checkout. Customers can check a box to subscribe to your newsletter. This check box will be added below the email address field. 830 | You can customize the text they will see by changing the text in the text box below. Currently only the old WooCommerce checkout is supported (so not the WooCommerce Blocks based checkout). 831 | ', 'integration-for-listmonk') . '
'; 832 | echo '(2) On any page on your website, using a custom newsletter form from the WPForms plugin that you can include anywhere on your website. You can enter the WPForms form ID on this settings page.
'; 833 | echo '(3) On any page on your website, using the Contact Form 7 plugin with the standard fields "your-name" and "your-email" present. Below you can enter the page ID of the page you have enabled the Contact Form 7 form.
'; 834 | echo 'See the listmonk documentation for more information on how to setup listmonk, either on your own server or easily hosted versions on services like Railway and Pikapods.
835 | '; 836 | } 837 | 838 | // Description for the 'listmonk Credentials' section 839 | function listmonk_credentials_description() { // Function to render the description for the 'listmonk Credentials' section 840 | echo '' . esc_html__('In order for the integration to work, you need to provide your listmonk credentials. First input the listmonk list ID you want to 841 | send all new subscribers to. This ID is shown in listmonk when you click on a list. Second, you input the url of your listmonk server. Third, you input your listmonk API username and API access token for authentication. For this you need to create a new user in listmonk settings under Users. Starting with recent version of listmonk this needs to be a new API user: you cannot use the username and password you use to login to the listmonk admin page.', 'integration-for-listmonk') . '
'; 842 | } 843 | 844 | // Description for the 'listmonk Credentials' section 845 | function listmonk_debug_description() { // Function to render the description for the 'listmonk Credentials' section 846 | echo '' . esc_html__('Debug mode can be enabled here. When enabled, debug information will be rendered in the WordPress log file.') . '
'; 847 | } 848 | 849 | // Hook into the admin_enqueue_scripts action 850 | add_action('admin_enqueue_scripts', 'listmonk_admin_styles'); 851 | 852 | // Function to add custom styles to the admin page 853 | function listmonk_admin_styles($hook) { 854 | // Check if we're on the specific plugin admin page 855 | if ('settings_page_listmonk_integration' !== $hook) { 856 | return; 857 | } 858 | 859 | // Add custom CSS 860 | ?> 861 | 870 | '; 879 | echo '' . esc_html__('This text will be shown on the WooCommerce checkout page when listmonk integration is enabled.', 'integration-for-listmonk') . '
'; 880 | } 881 | 882 | function listmonk_render_text_field($args){ 883 | $field_type = 'text'; 884 | $autocomplete = ''; // Autocomplete attribute 885 | $placeholder = ''; // Default placeholder text 886 | $help_text = ''; // Default help text 887 | 888 | // If the field is for the password 889 | if ($args['name'] == 'listmonk_password') { 890 | $field_type = 'password'; 891 | $autocomplete = 'autocomplete="new-password"'; // Set autocomplete attribute for password field 892 | $placeholder = 'Enter new password to change'; // Informative placeholder text for the password field 893 | $help_text = '' . esc_html__('Leave blank to keep the current API access token.', 'integration-for-listmonk') . '
';// Help text for the password field 894 | } else if ($args['name'] == 'listmonk_username') { 895 | $autocomplete = 'autocomplete="username"'; // Set autocomplete attribute for username field 896 | } 897 | $option = get_option($args['name'], ''); // Get the option value for other fields 898 | 899 | // Print the input field 900 | printf( 901 | '', // The placeholders are replaced with the specified values 902 | esc_attr($field_type), // Field type (text or password) 903 | esc_attr($args['name']), // Field ID 904 | esc_attr($args['name']), // Field name 905 | esc_attr($field_type == 'password' ? '' : $option), // Field value, empty for password fields 906 | esc_attr($placeholder), // Placeholder text 907 | esc_attr($autocomplete) // Autocomplete attribute 908 | ); 909 | 910 | // Echo the help text 911 | if (!empty($help_text)) { 912 | echo wp_kses_post($help_text); // Help text 913 | } 914 | } 915 | 916 | function listmonk_render_checkbox_field($args){ // Function to render checkbox field 917 | $value = get_option($args['name']); // Get the current value of the option 918 | 919 | // Check if WPForms or any plugin with a name starting with "wpforms" is active 920 | if ($args['name'] === 'listmonk_wpforms_integration_on' && !listmonk_is_plugin_active_with_prefix('wpforms')) { 921 | // WPForms or a matching plugin is not active and the field is "listmonk_wpforms_integration_on," disable the checkbox and set it as unchecked 922 | $disabled = 'disabled="disabled"'; 923 | $checked = ''; 924 | $message = esc_html__('WPForms is not installed', 'integration-for-listmonk'); // Message for when WPForms is not installed 925 | } elseif($args['name'] === 'listmonk_checkout_on' && listmonk_is_woocommerce_activated() == false){ // check if woocommerce is active 926 | // Woocommerce is not active and the field is "listmonk_checkout_on," disable the checkbox and set it as unchecked 927 | $disabled = 'disabled="disabled"'; 928 | $checked = ''; 929 | $message = esc_html__('WooCommerce is not installed', 'integration-for-listmonk'); // Message for when WooCommerce is not installed 930 | } elseif($args['name'] === 'listmonk_cf7_integration_on' && !listmonk_is_plugin_active_with_prefix('contact-form-7')){ // check if woocommerce is active 931 | // Woocommerce is not active and the field is "listmonk_checkout_on," disable the checkbox and set it as unchecked 932 | $disabled = 'disabled="disabled"'; 933 | $checked = ''; 934 | $message = esc_html__('Contact Form 7 is not installed', 'integration-for-listmonk'); // Message for when WooCommerce is not installed 935 | } else { 936 | // WPForms or a matching plugin is active or the field is not "listmonk_wpforms_integration_on," enable the checkbox and set its value based on the option 937 | $disabled = ''; 938 | $checked = checked($value, 'yes', false); // Set to checked if the option value is ' yes' 939 | $message = ''; // No message when WPForms is active or the field is not "listmonk_wpforms_integration_on" 940 | } 941 | 942 | ?> 943 | 946 | ' . esc_html($message) . ''; // Show message if WPForms is not installed 949 | } 950 | // in listmonk-admin.js there is js code that was previously located here 951 | } 952 | 953 | function listmonk_is_plugin_active_with_prefix($prefix){ // Function to check if a plugin with a name starting with a prefix is active 954 | $active_plugins = get_option('active_plugins'); // Get all active plugins 955 | 956 | foreach ($active_plugins as $plugin) { // Loop through all active plugins 957 | if (strpos($plugin, $prefix) === 0) { // Check if the plugin name starts with the prefix 958 | return true; 959 | } 960 | } 961 | 962 | return false; 963 | } 964 | 965 | // Function to render WPForms Form ID field 966 | function listmonk_render_wpforms_form_id_field($args) { 967 | $option_name = esc_attr($args['name']); 968 | $value = esc_attr(get_option($option_name, '')); // Default value if option is not set 969 | $disabled = get_option('listmonk_wpforms_integration_on') !== 'yes' ? 'readonly' : ''; 970 | 971 | echo ''; 972 | echo '' . esc_html__('Enter the WPForms Form ID here. This ID is used when listmonk integration with WPForms is enabled.', 'integration-for-listmonk') . '
'; 973 | } 974 | 975 | // Function to render Contact Form 7 ID field 976 | function listmonk_render_cf7_form_id_field($args) { 977 | $option_name = esc_attr($args['name']); 978 | $value = esc_attr(get_option($option_name, '')); // Default value if option is not set 979 | $disabled = get_option('listmonk_cf7_integration_on') !== 'yes' ? 'readonly' : ''; 980 | 981 | echo ''; 982 | echo '' . esc_html__('Enter the page ID of the page where the Contact Form 7 form is active. This ID is used when listmonk integration with Contact Form 7 is enabled to let people subscribe to listmonk through a form. This is the page ID of the page where you entered the Contact Form 7 shortcode to render your form.', 'integration-for-listmonk') . '
'; 983 | } 984 | 985 | // Function to render listmonk List ID field 986 | function listmonk_render_listmonk_list_id_field($args) { // Function to render listmonk List ID field 987 | $option = get_option($args['name'], '1'); // Default value is 1 988 | 989 | printf( 990 | '', // The %s placeholders are replaced with the values in the following order 991 | esc_attr($args['name']), 992 | esc_attr($option) 993 | ); 994 | } 995 | 996 | // Render a button on the WordPress plugin page to easily access this plugin's settings 997 | function listmonk_plugin_page_settings_link($links) { 998 | $settings_link = 'Settings'; 999 | array_unshift($links, $settings_link); 1000 | return $links; 1001 | } 1002 | 1003 | add_filter('plugin_action_links_' . plugin_basename( __FILE__ ) . '', 'listmonk_plugin_page_settings_link'); 1004 | 1005 | ?> 1006 | -------------------------------------------------------------------------------- /readme.txt: -------------------------------------------------------------------------------- 1 | === Integration for listmonk mailing list and newsletter service === 2 | Contributors: postduif 3 | Tags: listmonk, newsletter, WordPress, WooCommerce, subscribers, mail, mailing, api 4 | Donate link: https://buymeacoffee.com/postduif 5 | Requires at least: 6.4 6 | Tested up to: 6.8.1 7 | Requires PHP: 7.4 8 | Stable tag: 1.4.1 9 | License: GNU General Public License v3.0 10 | License URI: https://www.gnu.org/licenses/gpl-3.0.html#license-textf 11 | 12 | Integrates the open-source mailing list tool listmonk with WordPress/WooCommerce so users can subscribe to your mailing list. 13 | 14 | == Description == 15 | This WordPress plugin integrates listmonk with your WordPress / WooCommerce website. 16 | 17 | You can use this plugin to: 18 | 19 | - Let people subscribe to your newsletter through a form on your website using WPForms or Contact Form 7. 20 | - Allow people to subscribe to your newsletter from the WooCommerce checkout page. After a customer pays, their email address and name will be sent to the listmonk mailing list of your choice. 21 | 22 | Using listmonk as an open-source newsletter and mailing tool makes you less dependent on services like Mailchimp, costs less, and has no limits on the amount of emails you can send per month. 23 | 24 | ## How to use this plugin 25 | 1. Install this plugin through the WordPress plugin directory. 26 | 2. Ensure you have access to a configured listmonk server. You can connect listmonk to email services like Amazon SES, which costs as little as $0.10 per thousand emails. 27 | 3. Access the plugin's settings page from your WordPress admin dashboard under Settings to enable and disable components and enter listmonk credentials. 28 | 4. Determine the listmonk list ID you want to subscribe people to. See listmonk documentation for more details. 29 | 5. Utilize WPForms, Contact Form 7, or a custom field on the WooCommerce checkout page to send subscriber data to listmonk. 30 | 6. When using a custom field on the WooCommerce checkout page, you can input a text customers will see during checkout. 31 | 32 | ## Requirements 33 | - WordPress website (latest version recommended); 34 | - Accessible listmonk server over HTTPS (tested up to listmonk v3.0.0); 35 | - WPForms or Contact Form 7 for form-based subscriptions; 36 | - WooCommerce for checkout-based subscriptions; (classic checkout supported, block-based checkout experimentally supported). 37 | 38 | ## Privacy and Security 39 | For compliance purposes, this plugin records the IP address each subscriber and sends it to your listmonk server. Subscribers through WooCommerce checkout do not require double opt-in, unlike form-based subscriptions. API credentials are stored securely on your server with encryption for the password. Please note that this plugin does not have any form of rate-limiting, so it is your own responsibilty to use a CATCHPA when using i.e. WPForms, to limit the amount of fake subscriptions that could be sent to your listmonk server. 40 | 41 | ## Suggestions, Bugs, and Contributions 42 | For bugs or suggestions, please create an issue on GitHub. Contributions, especially from those knowledgeable in PHP and the listmonk API, are welcome. 43 | 44 | ## License 45 | GNU General Public License v3.0. No commercial closed-source usage allowed. 46 | 47 | ## Thanks 48 | Huge thanks to Kailash Nadh for creating listmonk! 49 | 50 | ## Dependency on external services 51 | This plugin uses two external services: (1) a listmonk server of your choice, for which you are solely responsible and (2) a link to [Buy me a Coffee](buymeacoffee.com) to voluntarily support the development of this plugin. See their privacy policy [here](https://www.buymeacoffee.com/privacy-policy). This plugin can be used without donating. This plugin does not store or use any customer data: this is all being handled by the listmonk server you connect to. 52 | 53 | == Installation == 54 | Installation is straightforward. Install the plugin from the WordPress plugin directory and configure it from the settings page: Integration for listmonk. 55 | 56 | == Frequently Asked Questions == 57 | # I don't have a listmonk server, will this plugin work? 58 | No, you need a listmonk server for this plugin to work. You can either host one yourself, or use easy and freely available services lika Pikapods or Railway. 59 | 60 | # I don't have a listmonk server, do you have any recommendations on how to set up listmonk easily? 61 | Consider hosting listmonk on a user-friendly hosting service like [Pikapods](https://www.pikapods.com/). Check out the [GitHub guide](https://gist.github.com/MaximilianKohler/e5158fcfe6de80a9069926a67afcae11) by MaximillianKohler for more advanced tips on how to set up listmonk. 62 | 63 | # Where do I enter my listmonk credentials? 64 | You can find the plugin's settings, called "Integration for listmonk" under the Settings tab in WordPress. There you need to enable the components you want to use (form based and/or checkout based subscription) and fill in your credentials. 65 | 66 | # Where do I find my listmonk list ID? 67 | Click on a mailing list you created in listmonk. On the upper corner it should display the ID. 68 | 69 | # Do users have to do double opt-in after subscribing to a mailing list? 70 | Only if you use the form-based component of this plugin. For all users that subscribe to a mailing list via the WooCommerce checkout page, their email address is already assumed confirmed, because it is unlikely someone will pay for a product with another persons email address just to spam them. 71 | 72 | # What about security? 73 | This plugin encrypts your listmonk password before storing it in the WordPress database. Always make sure to choose long and unique passwords; this is your own responsibility. 74 | 75 | # I have a problem with listmonk, can you help me out? 76 | Please submit an issue to the listmonk Github repository (I am not the maintainer of listmonk). 77 | 78 | # What form do I have to select when I use WPForms? 79 | The plugin only works with the default "newsletter" form, which has a first/last name field and an email field. 80 | 81 | # Where can I find the WPForms Form ID? 82 | Check the shortcode of the form you created. It should be formatted like "wpforms id=100", where 100 is the Form ID that you need to enter in the listmonk integration settings page. 83 | 84 | # What form do I have to select when I use Contact Form 7? 85 | Make sure the forms contains the fields 'your-email' and 'your-name' in order for this plugin to work. 86 | 87 | # How do I find the page ID for the Contact Form 7 integration? 88 | This refers to the page ID of the page you entered the Contact Form 7 shortcode on. If you edit that page in your WordPress admin panel, the url will contain for example "page=57". That number you will need to enter in the listmonk integration settings. 89 | 90 | # I have a problem with this plugin, can you help me? 91 | I created this plugin in my free time. I may have time to help you, but no guarantees! 92 | 93 | == Screenshots == 94 | 1. Settings page of the plugin. 95 | 2. Newsletter opt-in on the WooCommerce checkout. After a customer pays, their email address and name will be sent to the mailing list of your choice. 96 | 3. Newsletter subscription form example. Created with WPForms, data will be sent to your listmonk server. 97 | 98 | == Changelog == 99 | 1.4.0 Added support for WooCommerce block based checkout and added a debug mode 100 | 1.3.7 Small bug fixes, added id value for checkbox during checkout, breaking change: label for checkout box changed from newsletter_optin to listmonk_newsletter_optin 101 | 1.3.6 Fix: nonce verification error with WC checkout 102 | 1.3.5 Bug fix with WooCommerce checkout 103 | 1.3.4 Small changes, added a warning that CF7 support is still experimental 104 | 1.3.3 First public version on the WordPress plugin directory --------------------------------------------------------------------------------