Bulk_Delete_Post_Meta

Complexity

Total Complexity

15

Size/Duplication

Total Lines	305
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Test Coverage

Coverage

0%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	add_delete_post_meta_box()	0	9	1
B	do_delete_post_meta()	0	42	3
B	render_delete_post_meta_box()	0	145	4
A	filter_js_array()	0	8	1

<?php
/**
 * Utility class for deleting Post Meta.
 *
 * @since      5.4
 *
 * @author     Sudar
 *
 * @package    BulkDelete\Meta
 */
class Bulk_Delete_Post_Meta {
	/**
	 * Box slug.
	 *
	 * @since 5.4
	 */
	const BOX_POST_META = 'bd-post-meta';

	/**
	 * Cron Hook.
	 *
	 * @since 5.4
	 */
	const CRON_HOOK     = 'do-bulk-delete-post-meta';

	/**
	 * Register post-meta meta box for delete meta page.
	 *
	 * @static
	 *
	 * @since 5.4
	 */
	public static function add_delete_post_meta_box() {
		$bd = BULK_DELETE();

		add_meta_box(
			self::BOX_POST_META,
			__( 'Bulk Delete Post Meta', 'bulk-delete' ),
			array( __CLASS__, 'render_delete_post_meta_box' ),
			$bd->meta_page,
			'advanced'
		);
	}

	/**
	 * Render delete post-meta meta box for delete meta page.
	 *
	 * @static
	 *
	 * @since 5.4
	 */
	public static function render_delete_post_meta_box() {
		if ( Bulk_Delete_Meta::is_meta_box_hidden( self::BOX_POST_META ) ) {
			printf( __( 'This section just got enabled. Kindly <a href = "%1$s">refresh</a> the page to fully enable it.', 'bulk-delete' ), 'admin.php?page=' . Bulk_Delete_meta::META_PAGE_SLUG );

			return;
		}
?>
        <!-- Post Meta box start-->
        <fieldset class="options">
<?php
		$types = get_post_types( array(
				'public'   => true,
				'_builtin' => false,
			), 'names'
		);

		array_unshift( $types, 'post' );
?>
        <h4><?php _e( 'Select the post type whose post meta fields you want to delete', 'bulk-delete' ); ?></h4>
        <table class="optiontable">
<?php
		foreach ( $types as $type ) {
?>
            <tr>
                <td>
                    <input name="smbd_pm_post_type" value = "<?php echo $type; ?>" type = "radio" class = "smbd_pm_post_type" <?php checked( $type, 'post' ); ?>>
                    <label for="smbd_pm_post_type"><?php echo $type; ?> </label>
                </td>
            </tr>
<?php
		}
?>
        </table>

        <h4><?php _e( 'Choose your post meta field settings', 'bulk-delete' ); ?></h4>
        <table class="optiontable">
            <tr>
                <td>
                    <input name="smbd_pm_use_value" value="use_key" type="radio" checked>
                    <label for="smbd_pm_use_value"><?php echo __( 'Delete based on post meta key name only', 'bulk-delete' ); ?></label>
                </td>
            </tr>

            <tr>
                <td>
                    <input name="smbd_pm_use_value" id="smdb_pm_use_key_compare" value="use_key_compare" type="radio" disabled>
                    <label for="smbd_pm_use_value"><?php echo __( 'Delete based on post meta key name prefix or postfix', 'bulk-delete' ); ?></label>
                    <span class="bd-pm-pro" style="color:red; vertical-align: middle;">
                        <?php _e( 'Only available in Pro Addon', 'bulk-delete' ); ?> <a href = "http://bulkwp.com/addons/bulk-delete-post-meta/?utm_source=wpadmin&utm_campaign=BulkDelete&utm_medium=buynow&utm_content=bd-m-p" target="_blank">Buy now</a>
                    </span>
                </td>
            </tr>

            <tr>
                <td>
                    <input name="smbd_pm_use_value" id="smbd_pm_use_value" value="use_value" type="radio" disabled>
                    <label for="smbd_pm_use_value"><?php echo __( 'Delete based on post meta key name and value', 'bulk-delete' ); ?></label>
                    <span class="bd-pm-pro" style="color:red; vertical-align: middle;">
                        <?php _e( 'Only available in Pro Addon', 'bulk-delete' ); ?> <a href = "http://bulkwp.com/addons/bulk-delete-post-meta/?utm_source=wpadmin&utm_campaign=BulkDelete&utm_medium=buynow&utm_content=bd-m-p" target="_blank">Buy now</a>
                    </span>
                </td>
            </tr>

            <tr>
                <td>
                    <label for="smbd_pm_key"><?php _e( 'Post Meta Key ', 'bulk-delete' ); ?></label>
                    <select name="smbd_pm_key_prefix_postfix" id="smbd_pm_key_prefix_postfix" style="display: none;">
                        <option value="starts_with">starts with</option>
                        <option value="contains">contains</option>
                        <option value="ends_with">ends with</option>
                    </select>
                    <input name="smbd_pm_key" id="smbd_pm_key" placeholder="<?php _e( 'Meta Key', 'bulk-delete' ); ?>">
                </td>
            </tr>
        </table>
<?php
		/**
		 * Add more fields to the delete post meta field form.
		 * This hook can be used to add more fields to the delete post meta field form.
		 *
		 * @since 5.4
		 */
		do_action( 'bd_delete_post_meta_form' );
?>
        <table class="optiontable">
            <tr>
                <td>
                    <h4><?php _e( 'Choose your deletion options', 'bulk-delete' ); ?></h4>
                </td>
            </tr>

            <tr>
                <td>
                    <input name="smbd_pm_restrict" id="smbd_pm_restrict" value = "true" type = "checkbox" >
                    <?php _e( 'Only restrict to posts which are ', 'bulk-delete' );?>
                    <select name="smbd_pm_op" id="smbd_pm_op" disabled>
                        <option value ="before"><?php _e( 'older than', 'bulk-delete' );?></option>
                        <option value ="after"><?php _e( 'posted within last', 'bulk-delete' );?></option>
                    </select>
                    <input type ="textbox" name="smbd_pm_days" id="smbd_pm_days" disabled value ="0" maxlength="4" size="4"><?php _e( 'days', 'bulk-delete' );?>
                </td>
            </tr>

            <tr>
                <td>
                    <input name="smbd_pm_limit" id="smbd_pm_limit" value = "true" type = "checkbox">
                    <?php _e( 'Only delete post meta field from first ', 'bulk-delete' );?>
                    <input type ="textbox" name="smbd_pm_limit_to" id="smbd_pm_limit_to" disabled value ="0" maxlength="4" size="4"><?php _e( 'posts.', 'bulk-delete' );?>
                    <?php _e( 'Use this option if there are more than 1000 posts and the script times out.', 'bulk-delete' ) ?>
                </td>
            </tr>

            <tr>
                <td>
                    <input name="smbd_pm_cron" value = "false" type = "radio" checked="checked"> <?php _e( 'Delete now', 'bulk-delete' ); ?>
                    <input name="smbd_pm_cron" value = "true" type = "radio" id = "smbd_pm_cron" disabled > <?php _e( 'Schedule', 'bulk-delete' ); ?>
                    <input name="smbd_pm_cron_start" id = "smbd_pm_cron_start" value = "now" type = "text" disabled><?php _e( 'repeat ', 'bulk-delete' );?>
                    <select name="smbd_pm_cron_freq" id = "smbd_pm_cron_freq" disabled>
                        <option value = "-1"><?php _e( "Don't repeat", 'bulk-delete' ); ?></option>
<?php
		$schedules = wp_get_schedules();
		foreach ( $schedules as $key => $value ) {
?>
                        <option value = "<?php echo $key; ?>"><?php echo $value['display']; ?></option>
<?php
		}
?>
                    </select>
                    <span class="bd-pm-pro" style="color:red">
                        <?php _e( 'Only available in Pro Addon', 'bulk-delete' ); ?> <a href = "http://bulkwp.com/addons/bulk-delete-post-meta/?utm_source=wpadmin&utm_campaign=BulkDelete&utm_medium=buynow&utm_content=bd-m-p">Buy now</a>
                    </span>
                </td>
            </tr>

            <tr>
                <td>
                    <?php _e( 'Enter time in Y-m-d H:i:s format or enter now to use current time', 'bulk-delete' );?>
                </td>
            </tr>

        </table>
        </fieldset>

        <p>
            <button type="submit" name="bd_action" value="delete_meta_post" class="button-primary"><?php _e( 'Bulk Delete ', 'bulk-delete' ) ?>&raquo;</button>
        </p>
        <!-- Post Meta box end-->
<?php
	}

	/**
	 * Filter JS Array and add validation hooks.
	 *
	 * @since 5.4
	 * @static
	 *
	 * @param array $js_array JavaScript Array
	 *
	 * @return array Modified JavaScript Array
	 */
	public static function filter_js_array( $js_array ) {
		$js_array['dt_iterators'][]                 = '_pm';
		$js_array['validators']['delete_meta_post'] = 'noValidation';

		$js_array['pre_action_msg']['delete_meta_post'] = 'deletePMWarning';
		$js_array['msg']['deletePMWarning']             = __( 'Are you sure you want to delete all the post meta fields that match the selected filters?', 'bulk-delete' );

		return $js_array;
	}

	/**
	 * Controller for deleting post meta fields.
	 *
	 * @static
	 *
	 * @since  5.4
	 */
	public static function do_delete_post_meta() {
		$delete_options              = array();
		$delete_options['post_type'] = esc_sql( array_get( $_POST, 'smbd_pm_post_type', 'post' ) );

		$delete_options['use_value'] = bd_array_get( $_POST, 'smbd_pm_use_value', 'use_key' );
		$delete_options['meta_key']  = esc_sql( array_get( $_POST, 'smbd_pm_key', '' ) );

		$delete_options['limit_to']  = absint( array_get( $_POST, 'smbd_pm_limit_to', 0 ) );

		$delete_options['restrict']  = array_get_bool( $_POST, 'smbd_pm_restrict', false );
		$delete_options['op']        = esc_sql( array_get( $_POST, 'smbd_pm_op', 'before' ) );
		$delete_options['days']      = absint( array_get( $_POST, 'smbd_pm_days', 0 ) );

		/**
		 * Delete post-meta delete options filter.
		 * This filter is for processing filtering options for deleting post meta.
		 *
		 * @since 5.4
		 */
		$delete_options = apply_filters( 'bd_delete_post_meta_options', $delete_options, $_POST );

		if ( 'true' == array_get( $_POST, 'smbd_pm_cron', 'false' ) ) {
			$freq = $_POST['smbd_pm_cron_freq'];
			$time = strtotime( $_POST['smbd_pm_cron_start'] ) - ( get_option( 'gmt_offset' ) * 60 * 60 );

			if ( $freq == -1 ) {
				wp_schedule_single_event( $time, self::CRON_HOOK, array( $delete_options ) );
			} else {
				wp_schedule_event( $time, $freq, self::CRON_HOOK, array( $delete_options ) );
			}
			$msg = __( 'Post meta fields from the posts with the selected criteria are scheduled for deletion.', 'bulk-delete' ) . ' ' .
				sprintf( __( 'See the full list of <a href = "%s">scheduled tasks</a>' , 'bulk-delete' ), get_bloginfo( 'wpurl' ) . '/wp-admin/admin.php?page=' . Bulk_Delete::CRON_PAGE_SLUG );
		} else {
			$deleted_count = self::delete_post_meta( $delete_options );
			$msg           = sprintf( _n( 'Deleted post meta field from %d post', 'Deleted post meta field from %d posts' , $deleted_count, 'bulk-delete' ), $deleted_count );
		}

		add_settings_error(
			Bulk_Delete_Meta::META_PAGE_SLUG,
			'deleted-posts',
			$msg,
			'updated'
		);
	}

	/**
	 * Delete Post Meta.
	 *
	 * @static
	 *
	 * @since  5.4
	 *
	 * @param array $delete_options Options for deleting
	 *
	 * @return int Number of posts that were deleted
	 */
	public static function delete_post_meta( $delete_options ) {
		$count     = 0;
		$post_type = $delete_options['post_type'];
		$limit_to  = $delete_options['limit_to'];
		$meta_key  = $delete_options['meta_key'];
		$use_value = $delete_options['use_value'];
		$restrict  = $delete_options['restrict'];
		$days      = $delete_options['days'];
		$op        = $delete_options['op'];

		$options = array(
			'post_status' => 'publish',
			'post_type'   => $post_type,
		);

		if ( $limit_to > 0 ) {
			$options['showposts'] = $limit_to;
		} else {
			$options['nopaging'] = 'true';
		}

		if ( $restrict ) {
			$options['date_query'] = array(
				array(
					'column' => 'post_date',
					$op      => "{$days} day ago",
				),
			);
		}

		if ( 'use_key' === $use_value ) {
			$options['meta_key'] = $meta_key;
		} else {
			$options['meta_query'] = apply_filters( 'bd_delete_post_meta_query', array(), $delete_options );
		}

		$post_ids = bd_query( $options );
		foreach ( $post_ids as $post_id ) {
			if ( isset( $delete_options['meta_keys'] ) && is_array( $delete_options['meta_keys'] ) ) {
				$is_post_id_counted = false;
				foreach ( $delete_options['meta_keys'] as $meta_key ) {
					if ( delete_post_meta( $post_id, $meta_key ) ) {
						if ( $is_post_id_counted ) {
							continue;
						}
						$count++;
						$is_post_id_counted = true;
					}
				}
			} else {
				if ( delete_post_meta( $post_id, $meta_key ) ) {
					$count++;
				}
			}
		}

		return $count;
	}
}

// hooks
add_action( 'bd_add_meta_box_for_meta', array( 'Bulk_Delete_Post_Meta', 'add_delete_post_meta_box' ) );
add_action( 'bd_delete_meta_post', array( 'Bulk_Delete_Post_Meta', 'do_delete_post_meta' ) );

add_filter( 'bd_javascript_array', array( 'Bulk_Delete_Post_Meta', 'filter_js_array' ) );
?>