Passed
Push — 272-feature/delete-user-post-m... ( 502c9a...c21b3f )
by Rajan
06:31
created

DeleteUserMetaModule   A

Complexity

Total Complexity 12

Size/Duplication

Total Lines 181
Duplicated Lines 0 %

Test Coverage

Coverage 45.28%

Importance

Changes 0
Metric Value
dl 0
loc 181
ccs 24
cts 53
cp 0.4528
rs 10
c 0
b 0
f 0
wmc 12

6 Methods

Rating   Name   Duplication   Size   Complexity  
A convert_user_input_to_options() 0 7 1
A filter_js_array() 0 8 1
A get_success_message() 0 3 1
B render() 0 105 3
A initialize() 0 8 1
B delete() 0 30 5
1
<?php
2
namespace BulkWP\BulkDelete\Core\Metas\Modules;
3
4
use BulkWP\BulkDelete\Core\Metas\MetasModule;
5
6 1
defined( 'ABSPATH' ) || exit; // Exit if accessed directly.
7
8
/**
9
 * Delete User Meta.
10
 *
11
 * @since 6.0.0
12
 */
13
class DeleteUserMetaModule extends MetasModule {
14 1
	protected function initialize() {
15 1
		$this->field_slug    = 'user_comment';
16 1
		$this->meta_box_slug = 'bd-user-meta';
17 1
		$this->action        = 'delete_user_comment';
18 1
		$this->cron_hook     = 'do-bulk-delete-user-meta';
19 1
		$this->messages      = array(
20 1
			'box_label' => __( 'Bulk Delete User Meta', 'bulk-delete' ),
21 1
			'scheduled' => __( 'User meta fields from the users with the selected criteria are scheduled for deletion.', 'bulk-delete' ),
22
		);
23 1
	}
24
25
	/**
26
	 * Render the Modules.
27
	 *
28
	 * @return void
29
	 */
30
	public function render() {
31
		?>
32
		<!-- User Meta box start-->
33
        <fieldset class="options">
34
        <h4><?php _e( 'Select the user role whose user meta fields you want to delete', 'bulk-delete' ); ?></h4>
35
        <table class="optiontable">
36
<?php
37
		$users_count = count_users();
38
		foreach ( $users_count['avail_roles'] as $role => $count ) {
39
?>
40
            <tr>
41
                <td>
42
                    <input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_role" value = "<?php echo $role; ?>" type = "radio" <?php checked( $role, 'administrator' ); ?>>
43
                    <label for="smbd_<?php echo esc_attr( $this->field_slug ); ?>_role"><?php echo $role; ?> (<?php echo $count . ' '; _e( 'Users', 'bulk-delete' ); ?>)</label>
44
                </td>
45
            </tr>
46
<?php
47
		}
48
?>
49
        </table>
50
51
        <h4><?php _e( 'Choose your user meta field settings', 'bulk-delete' ); ?></h4>
52
        <table class="optiontable">
53
            <tr>
54
                <td>
55
                    <input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_use_value" value="false" type="radio" checked>
56
                    <label for="smbd_<?php echo esc_attr( $this->field_slug ); ?>_use_value"><?php echo __( 'Delete based on user meta key name only', 'bulk-delete' ); ?></label>
57
                </td>
58
            </tr>
59
60
            <tr>
61
                <td>
62
                    <input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_use_value" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_use_value" value="true" type="radio" disabled>
63
                    <label for="smbd_<?php echo esc_attr( $this->field_slug ); ?>_use_value"><?php echo __( 'Delete based on user meta key name and value', 'bulk-delete' ); ?></label>
64
                    <span class="bd-um-pro" style="color:red; vertical-align: middle;">
65
                        <?php _e( 'Only available in Pro Addon', 'bulk-delete' ); ?> <a href = "http://bulkwp.com/addons/bulk-delete-user-meta/?utm_source=wpadmin&utm_campaign=BulkDelete&utm_medium=buynow&utm_content=bd-m-u" target="_blank">Buy now</a>
66
                    </span>
67
                </td>
68
            </tr>
69
70
            <tr>
71
                <td>
72
                    <label for="smbd_<?php echo esc_attr( $this->field_slug ); ?>_key"><?php _e( 'User Meta Key ', 'bulk-delete' ); ?></label>
73
                    <input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_key" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_key" placeholder="<?php _e( 'Meta Key', 'bulk-delete' ); ?>">
74
                </td>
75
            </tr>
76
        </table>
77
<?php
78
		/**
79
		 * Add more fields to the delete user meta field form.
80
		 * This hook can be used to add more fields to the delete user meta field form.
81
		 *
82
		 * @since 5.4
83
		 */
84
		do_action( 'bd_delete_user_meta_form' );
85
?>
86
        <table class="optiontable">
87
            <tr>
88
                <td>
89
                    <h4><?php _e( 'Choose your deletion options', 'bulk-delete' ); ?></h4>
90
                </td>
91
            </tr>
92
93
            <tr>
94
                <td>
95
                    <input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_limit" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_limit" value = "true" type = "checkbox">
96
                    <?php _e( 'Only delete user meta field from first ', 'bulk-delete' );?>
97
                    <input type ="textbox" name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_limit_to" id="smbd_<?php echo esc_attr( $this->field_slug ); ?>_limit_to" disabled value ="0" maxlength="4" size="4"><?php _e( 'users.', 'bulk-delete' );?>
98
                    <?php _e( 'Use this option if there are more than 1000 users and the script times out.', 'bulk-delete' ) ?>
99
                </td>
100
            </tr>
101
102
            <tr>
103
                <td>
104
                    <input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron" value = "false" type = "radio" checked="checked"> <?php _e( 'Delete now', 'bulk-delete' ); ?>
105
                    <input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron" value = "true" type = "radio" id = "smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron" disabled > <?php _e( 'Schedule', 'bulk-delete' ); ?>
106
                    <input name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron_start" id = "smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron_start" value = "now" type = "text" disabled><?php _e( 'repeat ', 'bulk-delete' );?>
107
                    <select name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron_freq" id = "smbd_<?php echo esc_attr( $this->field_slug ); ?>_cron_freq" disabled>
108
                        <option value = "-1"><?php _e( "Don't repeat", 'bulk-delete' ); ?></option>
109
<?php
110
		$schedules = wp_get_schedules();
111
		foreach ( $schedules as $key => $value ) {
112
?>
113
                        <option value = "<?php echo $key; ?>"><?php echo $value['display']; ?></option>
114
<?php
115
		}
116
?>
117
                    </select>
118
                    <span class="bd-um-pro" style="color:red">
119
                        <?php _e( 'Only available in Pro Addon', 'bulk-delete' ); ?> <a href = "http://bulkwp.com/addons/bulk-delete-user-meta/?utm_source=wpadmin&utm_campaign=BulkDelete&utm_medium=buynow&utm_content=bd-m-u">Buy now</a>
120
                    </span>
121
                </td>
122
            </tr>
123
124
            <tr>
125
                <td>
126
                    <?php _e( 'Enter time in Y-m-d H:i:s format or enter now to use current time', 'bulk-delete' );?>
127
                </td>
128
            </tr>
129
130
        </table>
131
        </fieldset>
132
133
        <p>
134
            <button type="submit" name="bd_action" value="delete_meta_user" class="button-primary"><?php _e( 'Bulk Delete ', 'bulk-delete' ) ?>&raquo;</button>
135
        </p>
136
        <!-- User Meta box end-->
137
		<?php
138
	}
139
140
	protected function convert_user_input_to_options( $request, $options ) {
141
		$options['post_type'] = esc_sql( bd_array_get( $request, 'smbd_' . $this->field_slug . '_post_type', 'post' ) );
142
143
		$options['use_value'] = bd_array_get_bool( $request, 'smbd_' . $this->field_slug . '_use_value', false );
144
		$options['meta_key']  = esc_sql( bd_array_get( $request, 'smbd_' . $this->field_slug . '_meta_key', '' ) );
145
146
		return $options;
147
	}
148
149 1
	public function delete( $options ) {
150 1
		$count     = 0;
151 1
		$user_role = $options['user_role'];
152 1
		$meta_key  = $options['meta_key'];
153 1
		$use_value = $options['use_value'];
154 1
		$limit_to  = $options['limit_to'];
155
156
		$options = array(
157 1
			'role' => $user_role,
158
		);
159
160 1
		if ( $limit_to > 0 ) {
161
			$options['number'] = $limit_to;
162
		}
163
164 1
		if ( $use_value ) {
165
			$options['meta_query'] = apply_filters( 'bd_delete_user_meta_query', array(), $delete_options );
0 ignored issues
show
Comprehensibility Best Practice introduced by
The variable $delete_options does not exist. Did you maybe mean $options?
Loading history...
166
		} else {
167 1
			$options['meta_key'] = $meta_key;
168
		}
169
170 1
		$users = get_users( $options );
171
172 1
		foreach ( $users as $user ) {
173 1
			if ( delete_user_meta( $user->ID, $meta_key ) ) {
174 1
				$count++;
175
			}
176
		}
177
178 1
		return $count;
179
	}
180
181
	public function filter_js_array( $js_array ) {
182
		$js_array['dt_iterators'][]                 = '_um';
183
		$js_array['validators']['delete_meta_user'] = 'noValidation';
184
185
		$js_array['pre_action_msg']['delete_meta_user'] = 'deleteUMWarning';
186
		$js_array['msg']['deleteUMWarning']             = __( 'Are you sure you want to delete all the user meta fields that match the selected filters?', 'bulk-delete' );
187
188
		return $js_array;
189
	}
190
191
	protected function get_success_message( $items_deleted ) {
192
		/* translators: 1 Number of posts deleted */
193
		return _n( 'Deleted user meta field from %d user', 'Deleted user meta field from %d users', $items_deleted, 'bulk-delete' );
194
	}
195
}
196