ML#123 - Ability To Set Global Custom Name

admin/general-tab-docs.php

@@ -1,3 +1,12 @@
+<!-- Global Name -->
+<div id="ml_general_right_docs_global_name_title" style="display: none;">
+    Global Name
+</div>
+<div id="ml_general_right_docs_global_name_content" style="display: none;">
+    Ability to enable/disable a custom global name; to override system-wide Magic Link references.
+</div>
+<!-- Global Name -->
+
 <!-- All Scheduling Enabled -->
 <div id="ml_general_right_docs_all_scheduling_enabled_title" style="display: none;">
     All Scheduling Enabled

admin/general-tab.php

@@ -33,6 +33,16 @@ private function process_scripts() {
 
     private function process_updates() {
         if ( isset( $_POST['ml_general_main_col_general_form_nonce'] ) && wp_verify_nonce( sanitize_key( wp_unslash( $_POST['ml_general_main_col_general_form_nonce'] ) ), 'ml_general_main_col_general_form_nonce' ) ) {
+            if ( isset( $_POST['ml_general_main_col_general_form_global_name'] ) ) {
+                $global_name = filter_var( wp_unslash( $_POST['ml_general_main_col_general_form_global_name'] ), FILTER_SANITIZE_FULL_SPECIAL_CHARS, FILTER_FLAG_NO_ENCODE_QUOTES );
+                Disciple_Tools_Bulk_Magic_Link_Sender_API::update_option( Disciple_Tools_Bulk_Magic_Link_Sender_API::$option_dt_magic_links_global_name, $global_name );
+            }
+
+            if ( isset( $_POST['ml_general_main_col_general_form_global_name_enabled'] ) ) {
+                $global_name_enabled = filter_var( wp_unslash( $_POST['ml_general_main_col_general_form_global_name_enabled'] ), FILTER_SANITIZE_FULL_SPECIAL_CHARS, FILTER_FLAG_NO_ENCODE_QUOTES );
+                Disciple_Tools_Bulk_Magic_Link_Sender_API::update_option( Disciple_Tools_Bulk_Magic_Link_Sender_API::$option_dt_magic_links_global_name_enabled, $global_name_enabled );
+            }
+
             if ( isset( $_POST['ml_general_main_col_general_form_all_scheduling_enabled'] ) ) {
                 $all_scheduling_enabled = filter_var( wp_unslash( $_POST['ml_general_main_col_general_form_all_scheduling_enabled'] ), FILTER_SANITIZE_FULL_SPECIAL_CHARS, FILTER_FLAG_NO_ENCODE_QUOTES );
                 Disciple_Tools_Bulk_Magic_Link_Sender_API::update_option( Disciple_Tools_Bulk_Magic_Link_Sender_API::$option_dt_magic_links_all_scheduling_enabled, $all_scheduling_enabled );
@@ -151,6 +161,38 @@ private function main_column_general() {
                     <a href='https://disciple.tools/user-docs/magic-links/' target='_blank'>Magic Links <img style="height: 20px" class="dt-icon" src="<?php echo esc_html( get_template_directory_uri() . '/dt-assets/images/help.svg' ) ?>"/></a>
                 </td>
             </tr>
+            <tr>
+                <td>
+                    Global Name [<a href="#" class="ml-general-docs"
+                                    data-title="ml_general_right_docs_global_name_title"
+                                    data-content="ml_general_right_docs_global_name_content">&#63;</a>]
+                </td>
+                <td>
+                    <?php
+                    $global_name_enabled_checked_html = 'checked';
+                    if ( ! Disciple_Tools_Bulk_Magic_Link_Sender_API::option_exists( Disciple_Tools_Bulk_Magic_Link_Sender_API::$option_dt_magic_links_global_name_enabled ) ) {
+                        // Ensure initial setup setting, is enabled by default
+                        Disciple_Tools_Bulk_Magic_Link_Sender_API::update_option( Disciple_Tools_Bulk_Magic_Link_Sender_API::$option_dt_magic_links_global_name_enabled, '1' );
+                    } else {
+                        $global_name_enabled_checked_html = boolval( Disciple_Tools_Bulk_Magic_Link_Sender_API::fetch_option( Disciple_Tools_Bulk_Magic_Link_Sender_API::$option_dt_magic_links_global_name_enabled ) ) ? 'checked' : '';
+                    }
+                    $global_name_value = get_option( Disciple_Tools_Bulk_Magic_Link_Sender_API::$option_dt_magic_links_global_name, '' );
+                    $global_name_disabled_html = ( $global_name_enabled_checked_html !== 'checked' ? 'disabled' : '' );
+                    ?>
+                    <input style="min-width: 70%;"
+                           type="text"
+                           id="ml_general_main_col_general_global_name"
+                           value="<?php echo esc_attr( $global_name_value ); ?>"
+                        <?php echo esc_attr( $global_name_disabled_html ); ?>
+                    />
+
+                    <input type="checkbox"
+                           id="ml_general_main_col_general_global_name_enabled"
+                           value=""
+                        <?php echo esc_attr( $global_name_enabled_checked_html ); ?>
+                    /> Enabled
+                </td>
+            </tr>
             <tr>
                 <td style="vertical-align: middle;">All Scheduling Enabled [<a href="#" class="ml-general-docs"
                                                                                data-title="ml_general_right_docs_all_scheduling_enabled_title"
@@ -215,6 +257,12 @@ private function main_column_general() {
                    name="ml_general_main_col_general_form_nonce"
                    value="<?php echo esc_attr( wp_create_nonce( 'ml_general_main_col_general_form_nonce' ) ) ?>"/>
 
+            <input type="hidden" id="ml_general_main_col_general_form_global_name"
+                   name="ml_general_main_col_general_form_global_name" value=""/>
+
+            <input type="hidden" id="ml_general_main_col_general_form_global_name_enabled"
+                   name="ml_general_main_col_general_form_global_name_enabled" value=""/>
+
             <input type="hidden" id="ml_general_main_col_general_form_all_scheduling_enabled"
                    name="ml_general_main_col_general_form_all_scheduling_enabled" value=""/>
 

admin/js/general-tab.js

@@ -9,14 +9,22 @@ jQuery(function ($) {
     handle_docs_request($(evt.currentTarget).data('title'), $(evt.currentTarget).data('content'));
   });
 
+  $(document).on('click', '#ml_general_main_col_general_global_name_enabled', function () {
+    $('#ml_general_main_col_general_global_name').prop('disabled', !$(this).prop('checked'));
+  });
+
   // Helper Functions
   function handle_update_request() {
     // Fetch values to be saved
+    let global_name = $('#ml_general_main_col_general_global_name').val();
+    let global_name_enabled = $('#ml_general_main_col_general_global_name_enabled').prop('checked');
     let all_scheduling_enabled = $('#ml_general_main_col_general_all_scheduling_enabled').prop('checked');
     let all_channels_enabled = $('#ml_general_main_col_general_all_channels_enabled').prop('checked');
     let default_time_zone = $('#ml_general_main_col_general_default_time_zone').val();
 
     // Update hidden form values
+    $('#ml_general_main_col_general_form_global_name').val(global_name);
+    $('#ml_general_main_col_general_form_global_name_enabled').val(global_name_enabled ? '1' : '0');
     $('#ml_general_main_col_general_form_all_scheduling_enabled').val(all_scheduling_enabled ? '1' : '0');
     $('#ml_general_main_col_general_form_all_channels_enabled').val(all_channels_enabled ? '1' : '0');
     $('#ml_general_main_col_general_form_default_time_zone').val(default_time_zone);

magic-link/magic-link-post-type.php

@@ -340,11 +340,12 @@ public function update_record( WP_REST_Request $request ) {
 
         $args = [];
         if ( !is_user_logged_in() ){
-            $args['comment_author'] = 'Magic Link Submission';
+            $global_name = apply_filters( 'dt_magic_link_global_name', __( 'Magic Link', 'disciple_tools' ) );
+            $args['comment_author'] = sprintf( __( '%s Submission', 'disciple_tools' ), $global_name );
             wp_set_current_user( 0 );
             $current_user = wp_get_current_user();
             $current_user->add_cap( 'magic_link' );
-            $current_user->display_name = 'Magic Link Submission';
+            $current_user->display_name = sprintf( __( '%s Submission', 'disciple_tools' ), $global_name );
         }
 
         if ( isset( $params['update']['comment'] ) && !empty( $params['update']['comment'] ) ){

magic-link/magic-link-templates.php

@@ -1799,6 +1799,6 @@ public function update_user_logged_in_state() {
         wp_set_current_user( 0 );
         $current_user = wp_get_current_user();
         $current_user->add_cap( 'magic_link' );
-        $current_user->display_name = __( 'Smart Link Submission', 'disciple_tools' );
+        $current_user->display_name = sprintf( __( '%s Submission', 'disciple_tools' ), apply_filters( 'dt_magic_link_global_name', __( 'Magic Link', 'disciple_tools' ) ) );
     }
 }

magic-link/magic-link-user-app.php

@@ -968,7 +968,7 @@ public function update_user_logged_in_state( $sys_type, $user_id ) {
                 wp_set_current_user( 0 );
                 $current_user = wp_get_current_user();
                 $current_user->add_cap( 'magic_link' );
-                $current_user->display_name = __( 'Smart Link Submission', 'disciple_tools' );
+                $current_user->display_name = sprintf( __( '%s Submission', 'disciple_tools' ), apply_filters( 'dt_magic_link_global_name', __( 'Magic Link', 'disciple_tools' ) ) );
                 break;
             default: // wp_user
                 wp_set_current_user( $user_id );

magic-link/magic-link-user-posts-base.php

@@ -1793,7 +1793,7 @@ public function update_user_logged_in_state( $sys_type, $user_id ) {
                 wp_set_current_user( 0 );
                 $current_user = wp_get_current_user();
                 $current_user->add_cap( 'magic_link' );
-                $current_user->display_name = __( 'Smart Link Submission', 'disciple_tools' );
+                $current_user->display_name = sprintf( __( '%s Submission', 'disciple_tools' ), apply_filters( 'dt_magic_link_global_name', __( 'Magic Link', 'disciple_tools' ) ) );
                 break;
             default: // wp_user
                 wp_set_current_user( $user_id );

magic-link/magic-links-api.php

@@ -9,6 +9,8 @@
 class Disciple_Tools_Bulk_Magic_Link_Sender_API {
 
     public static $option_dt_magic_links_objects = 'dt_magic_links_objects';
+    public static $option_dt_magic_links_global_name = 'dt_magic_links_global_name';
+    public static $option_dt_magic_links_global_name_enabled = 'dt_magic_links_global_name_enabled';
     public static $option_dt_magic_links_all_scheduling_enabled = 'dt_magic_links_all_scheduling_enabled';
     public static $option_dt_magic_links_all_channels_enabled = 'dt_magic_links_all_channels_enabled';
     public static $option_dt_magic_links_logging = 'dt_magic_links_logging';

magic-link/magic-links-default-filters.php

@@ -217,3 +217,21 @@ function dt_magic_link_continue( bool $response, array $args ){
 /**
  * LINK EXPIRY CHECKER
  */
+
+
+/**
+ * GLOBAL NAME
+ */
+
+add_filter( 'dt_magic_link_global_name', 'dt_magic_link_global_name', 10, 1 );
+function dt_magic_link_global_name( $global_name ) {
+    if ( boolval( get_option( Disciple_Tools_Bulk_Magic_Link_Sender_API::$option_dt_magic_links_global_name_enabled, false ) ) === true ) {
+        return get_option( Disciple_Tools_Bulk_Magic_Link_Sender_API::$option_dt_magic_links_global_name, $global_name );
+    }
+
+    return $global_name;
+}
+
+/**
+ * GLOBAL NAME
+ */