PostsMetabox::delete_posts_by_id() - Code Metrics - Inspection of "Merge branch 'dev/6.0.0' into 233-feature/posts-by..." - sudar/bulk-delete - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 233-feature/posts-by-post-stat... ( 0c4f56...dd14ac )

by Sudar

created 2018-04-10 03:38 UTC

PostsMetabox::delete_posts_by_id() A

↳ Parent: PostsMetabox

Complexity

Conditions	3
Paths	3

Size

Total Lines	12
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

Metric	Value
cc	3
eloc	6
nc	3
nop	2
dl	0
loc	12
rs	9.4285
c	0
b	0
f	0
ccs	0
cts	0
cp	0
crap	12

<?php
namespace BulkWP\BulkDelete\Core\Posts;

use BulkWP\BulkDelete\Core\Base\BaseMetabox;

defined( 'ABSPATH' ) || exit; // Exit if accessed directly.

/**
 * Metabox for deleting posts.
 *
 * @since 6.0.0
 */
abstract class PostsMetabox extends BaseMetabox {
	protected $item_type = 'posts';

	public function filter_js_array( $js_array ) {
		$js_array['msg']['deletePostsWarning'] = __( 'Are you sure you want to delete all the posts based on the selected option?', 'bulk-delete' );
		$js_array['msg']['selectPostOption']   = __( 'Please select posts from at least one option', 'bulk-delete' );

		$js_array['validators']['delete_posts_by_category'] = 'validateSelect2';
		$js_array['error_msg']['delete_posts_by_category']  = 'selectCategory';
		$js_array['msg']['selectCategory']                  = __( 'Please select at least one category', 'bulk-delete' );

		$js_array['validators']['delete_posts_by_tag']     = 'validateSelect2';
		$js_array['error_msg']['delete_posts_by_category'] = 'selectTag';
		$js_array['msg']['selectTag']                      = __( 'Please select at least one tag', 'bulk-delete' );

		$js_array['validators']['delete_posts_by_url'] = 'validateUrl';
		$js_array['error_msg']['delete_posts_by_url']  = 'enterUrl';
		$js_array['msg']['enterUrl']                   = __( 'Please enter at least one post url', 'bulk-delete' );

		$js_array['dt_iterators'][] = '_cats';
		$js_array['dt_iterators'][] = '_tags';
		$js_array['dt_iterators'][] = '_taxs';
		$js_array['dt_iterators'][] = '_types';
		$js_array['dt_iterators'][] = '_post_status';

		return $js_array;
	}

	/**
	 * Render the "private post" setting fields.
	 */
	protected function render_private_post_settings() {
		bd_render_private_post_settings( $this->field_slug );
	}

	/**
	 * Render Post type dropdown.
	 */
	protected function render_post_type_dropdown() {
		bd_render_post_type_dropdown( $this->field_slug );
	}

	/**
	 * Render Category dropdown.
	 */
	protected function render_category_dropdown() {
		$categories = $this->get_categories();
		?>

		<select name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_category[]" data-placeholder="<?php _e( 'Select Categories', 'bulk-delete' ); ?>"
				class="<?php echo sanitize_html_class( $this->enable_ajax_if_needed_to_dropdown_class_name( count( $categories ), 'select2-taxonomy' ) ); ?>"
				data-taxonomy="category" multiple>

			<option value="all">
				<?php _e( 'All Categories', 'bulk-delete' ); ?>
			</option>

			<?php foreach ( $categories as $category ) : ?>
				<option value="<?php echo absint( $category->cat_ID ); ?>">
					<?php echo esc_html( $category->cat_name ), ' (', absint( $category->count ), ' ', __( 'Posts', 'bulk-delete' ), ')'; ?>
				</option>
			<?php endforeach; ?>

		</select>
	<?php
	}

	/**
	 * Render Tags dropdown.
	 */
	protected function render_tags_dropdown() {
		$tags = $this->get_tags();
		?>

		<select name="smbd_<?php echo esc_attr( $this->field_slug ); ?>[]" data-placeholder="<?php _e( 'Select Tags', 'bulk-delete' ); ?>"
				class="<?php echo sanitize_html_class( $this->enable_ajax_if_needed_to_dropdown_class_name( count( $tags ), 'select2-taxonomy' ) ); ?>"
				data-taxonomy="post_tag" multiple>

			<option value="all">
				<?php _e( 'All Tags', 'bulk-delete' ); ?>
			</option>

			<?php foreach ( $tags as $tag ) : ?>
				<option value="<?php echo absint( $tag->term_id ); ?>">
					<?php echo esc_html( $tag->name ), ' (', absint( $tag->count ), ' ', __( 'Posts', 'bulk-delete' ), ')'; ?>
				</option>
			<?php endforeach; ?>
		</select>
	<?php
	}

	/**
	 * Get the list of post statuses.
	 *
	 * This includes all custom post status, but excludes built-in private posts.
	 *
	 * @return array List of post status objects.
	 */
	protected function get_post_statuses() {
		return bd_get_post_statuses();
	}

	/**
	 * Get the list of categories.
	 *
	 * @return array List of categories.
	 */
	protected function get_categories() {
		$enhanced_select_threshold = $this->get_enhanced_select_threshold();

		$categories = get_categories(
			array(
				'hide_empty' => false,
				'number'     => $enhanced_select_threshold,
			)
		);

		return $categories;
	}

	/**
	 * Are tags present in this WordPress installation?
	 *
	 * Only one tag is retrieved to check if tags are present for performance reasons.
	 *
	 * @return bool True if tags are present, False otherwise.
	 */
	protected function are_tags_present() {
		$tags = $this->get_tags( 1 );

		return ( count( $tags ) > 0 );
	}

	/**
	 * Get the list of tags.
	 *
	 * @param int $max_count The maximum number of tags to be returned (Optional). Default 0.
	 *                       If 0 then the maximum number of tags specified in `get_enhanced_select_threshold` will be returned.
	 *
	 * @return array List of tags.
	 */
	protected function get_tags( $max_count = 0 ) {
		if ( absint( $max_count ) === 0 ) {
			$max_count = $this->get_enhanced_select_threshold();
		}

		$tags = get_tags(
			array(
				'hide_empty' => false,
				'number'     => $max_count,
			)
		);

		return $tags;
	}

	/**
	 * Delete sticky posts.
	 *
	 * @param bool $force_delete Whether to bypass trash and force deletion.
	 *
	 * @return int Number of posts deleted.
	 */
	protected function delete_sticky_posts( $force_delete ) {
		$sticky_post_ids = get_option( 'sticky_posts' );

		if ( ! is_array( $sticky_post_ids ) ) {
			return 0;
		}

		return $this->delete_posts_by_id( $sticky_post_ids, $force_delete );
	}

	/**
	 * Delete posts by ids.
	 *
	 * @param int[] $post_ids     List of post ids to delete.
	 * @param bool  $force_delete True to force delete posts, False otherwise.
	 *
	 * @return int Number of posts deleted.
	 */
	protected function delete_posts_by_id( $post_ids, $force_delete ) {
		foreach ( $post_ids as $post_id ) {
			// `$force_delete` parameter to `wp_delete_post` won't work for custom post types.
			// See https://core.trac.wordpress.org/ticket/43672
			if ( $force_delete ) {
				wp_delete_post( $post_id, true );
			} else {
				wp_trash_post( $post_id );
			}
		}

		return count( $post_ids );
	}
}


1		<?php
2		namespace BulkWP\BulkDelete\Core\Posts;
3
4		use BulkWP\BulkDelete\Core\Base\BaseMetabox;
5
6	1	defined( 'ABSPATH' ) \|\| exit; // Exit if accessed directly.
7
8		/**
9		* Metabox for deleting posts.
10		*
11		* @since 6.0.0
12		*/
13		abstract class PostsMetabox extends BaseMetabox {
14		protected $item_type = 'posts';
15
16		public function filter_js_array( $js_array ) {
17		$js_array['msg']['deletePostsWarning'] = __( 'Are you sure you want to delete all the posts based on the selected option?', 'bulk-delete' );
18		$js_array['msg']['selectPostOption'] = __( 'Please select posts from at least one option', 'bulk-delete' );
19
20		$js_array['validators']['delete_posts_by_category'] = 'validateSelect2';
21		$js_array['error_msg']['delete_posts_by_category'] = 'selectCategory';
22		$js_array['msg']['selectCategory'] = __( 'Please select at least one category', 'bulk-delete' );
23
24		$js_array['validators']['delete_posts_by_tag'] = 'validateSelect2';
25		$js_array['error_msg']['delete_posts_by_category'] = 'selectTag';
26		$js_array['msg']['selectTag'] = __( 'Please select at least one tag', 'bulk-delete' );
27
28		$js_array['validators']['delete_posts_by_url'] = 'validateUrl';
29		$js_array['error_msg']['delete_posts_by_url'] = 'enterUrl';
30		$js_array['msg']['enterUrl'] = __( 'Please enter at least one post url', 'bulk-delete' );
31
32		$js_array['dt_iterators'][] = '_cats';
33		$js_array['dt_iterators'][] = '_tags';
34		$js_array['dt_iterators'][] = '_taxs';
35		$js_array['dt_iterators'][] = '_types';
36		$js_array['dt_iterators'][] = '_post_status';
37
38		return $js_array;
39		}
40
41		/**
42		* Render the "private post" setting fields.
43		*/
44		protected function render_private_post_settings() {
45		bd_render_private_post_settings( $this->field_slug );
46		}
47
48		/**
49		* Render Post type dropdown.
50		*/
51		protected function render_post_type_dropdown() {
52		bd_render_post_type_dropdown( $this->field_slug );
53		}
54
55		/**
56		* Render Category dropdown.
57		*/
58		protected function render_category_dropdown() {
59		$categories = $this->get_categories();
60		?>
61
62		<select name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_category[]" data-placeholder="<?php _e( 'Select Categories', 'bulk-delete' ); ?>"
63		class="<?php echo sanitize_html_class( $this->enable_ajax_if_needed_to_dropdown_class_name( count( $categories ), 'select2-taxonomy' ) ); ?>"
64		data-taxonomy="category" multiple>
65
66		<option value="all">
67		<?php _e( 'All Categories', 'bulk-delete' ); ?>
68		</option>
69
70		<?php foreach ( $categories as $category ) : ?>
71		<option value="<?php echo absint( $category->cat_ID ); ?>">
72		<?php echo esc_html( $category->cat_name ), ' (', absint( $category->count ), ' ', __( 'Posts', 'bulk-delete' ), ')'; ?>
73		</option>
74		<?php endforeach; ?>
75
76		</select>
77		<?php
78		}
79
80		/**
81		* Render Tags dropdown.
82		*/
83		protected function render_tags_dropdown() {
84		$tags = $this->get_tags();
85		?>
86
87		<select name="smbd_<?php echo esc_attr( $this->field_slug ); ?>[]" data-placeholder="<?php _e( 'Select Tags', 'bulk-delete' ); ?>"
88		class="<?php echo sanitize_html_class( $this->enable_ajax_if_needed_to_dropdown_class_name( count( $tags ), 'select2-taxonomy' ) ); ?>"
89		data-taxonomy="post_tag" multiple>
90
91		<option value="all">
92		<?php _e( 'All Tags', 'bulk-delete' ); ?>
93		</option>
94
95		<?php foreach ( $tags as $tag ) : ?>
96		<option value="<?php echo absint( $tag->term_id ); ?>">
97		<?php echo esc_html( $tag->name ), ' (', absint( $tag->count ), ' ', __( 'Posts', 'bulk-delete' ), ')'; ?>
98		</option>
99		<?php endforeach; ?>
100		</select>
101		<?php
102		}
103
104		/**
105		* Get the list of post statuses.
106		*
107		* This includes all custom post status, but excludes built-in private posts.
108		*
109		* @return array List of post status objects.
110		*/
111		protected function get_post_statuses() {
112		return bd_get_post_statuses();
113		}
114
115		/**
116		* Get the list of categories.
117		*
118		* @return array List of categories.
119		*/
120		protected function get_categories() {
121		$enhanced_select_threshold = $this->get_enhanced_select_threshold();
122
123		$categories = get_categories(
124		array(
125		'hide_empty' => false,
126		'number' => $enhanced_select_threshold,
127		)
128		);
129
130		return $categories;
131		}
132
133		/**
134		* Are tags present in this WordPress installation?
135		*
136		* Only one tag is retrieved to check if tags are present for performance reasons.
137		*
138		* @return bool True if tags are present, False otherwise.
139		*/
140		protected function are_tags_present() {
141		$tags = $this->get_tags( 1 );
142
143		return ( count( $tags ) > 0 );
144		}
145
146		/**
147		* Get the list of tags.
148		*
149		* @param int $max_count The maximum number of tags to be returned (Optional). Default 0.
150		* If 0 then the maximum number of tags specified in `get_enhanced_select_threshold` will be returned.
151		*
152		* @return array List of tags.
153		*/
154		protected function get_tags( $max_count = 0 ) {
155		if ( absint( $max_count ) === 0 ) {
156		$max_count = $this->get_enhanced_select_threshold();
157		}
158
159		$tags = get_tags(
160		array(
161		'hide_empty' => false,
162		'number' => $max_count,
163		)
164		);
165
166		return $tags;
167		}
168
169		/**
170		* Delete sticky posts.
171		*
172		* @param bool $force_delete Whether to bypass trash and force deletion.
173		*
174		* @return int Number of posts deleted.
175		*/
176		protected function delete_sticky_posts( $force_delete ) {
177		$sticky_post_ids = get_option( 'sticky_posts' );
178
179		if ( ! is_array( $sticky_post_ids ) ) {
180		return 0;
181		}
182
183		return $this->delete_posts_by_id( $sticky_post_ids, $force_delete );
184		}
185
186		/**
187		* Delete posts by ids.
188		*
189		* @param int[] $post_ids List of post ids to delete.
190		* @param bool $force_delete True to force delete posts, False otherwise.
191		*
192		* @return int Number of posts deleted.
193		*/
194		protected function delete_posts_by_id( $post_ids, $force_delete ) {
195		foreach ( $post_ids as $post_id ) {
196		// `$force_delete` parameter to `wp_delete_post` won't work for custom post types.
197		// See https://core.trac.wordpress.org/ticket/43672
198		if ( $force_delete ) {
199		wp_delete_post( $post_id, true );
200		} else {
201		wp_trash_post( $post_id );
202		}
203		}
204
205		return count( $post_ids );
206		}
207		}
208

sudar / bulk-delete

Push — 233-feature/posts-by-post-stat... ( 0c4f56...dd14ac )

PostsMetabox::delete_posts_by_id() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like