class-content-order.php — Admin and Site Enhancements (ASE) 8.2.2

admin-site-enhancements / classes / class-content-order.php

admin-site-enhancements / classes Last commit date

class-content-order.php

596 lines

1	<?php
2
3	namespace ASENHA\Classes;
4
5	use WP_Query;
6	/**
7	* Class for Content Order module
8	*
9	* @since 6.9.5
10	*/
11	class Content_Order {
12	/**
13	* Add "Custom Order" sub-menu for post types
14	*
15	* @since 5.0.0
16	*/
17	public function add_content_order_submenu( $context ) {
18	$options = get_option( ASENHA_SLUG_U, array() );
19	$content_order_for = ( isset( $options['content_order_for'] ) ? $options['content_order_for'] : array() );
20	$content_order_enabled_post_types = array();
21	if ( is_array( $content_order_for ) && count( $content_order_for ) > 0 ) {
22	foreach ( $content_order_for as $post_type_slug => $is_custom_order_enabled ) {
23	if ( $is_custom_order_enabled ) {
24	$post_type_object = get_post_type_object( $post_type_slug );
25	if ( is_object( $post_type_object ) && property_exists( $post_type_object, 'labels' ) ) {
26	$post_type_name_plural = $post_type_object->labels->name;
27	if ( 'post' == $post_type_slug ) {
28	$hook_suffix = add_posts_page(
29	$post_type_name_plural . ' Order',
30	// Page title
31	__( 'Order', 'admin-site-enhancements' ),
32	// Menu title
33	'edit_others_posts',
34	// Capability required
35	'custom-order-posts',
36	// Menu and page slug
37	[$this, 'custom_order_page_output']
38	);
39	} else {
40	if ( 'sfwd-courses' == $post_type_slug ) {
41	// LearnDash LMS Courses
42	// Add 'Order' submenu item under LearnDash menu
43	// Linked URL will be /wp-admin/admin.php?page=custom-order-sfwd-courses
44	// We will add a redirect to the correct URL via $this->maybe_perform_menu_link_redirects() hooked in admin_init
45	$hook_suffix = add_submenu_page(
46	'learndash-lms',
47	// Parent (menu) slug. Ref: https://developer.wordpress.org/reference/functions/add_submenu_page/#comment-1404
48	$post_type_name_plural . ' ' . __( 'Order', 'admin-site-enhancements' ),
49	// Page title
50	$post_type_name_plural . ' ' . __( 'Order', 'admin-site-enhancements' ),
51	// Menu title
52	'edit_others_posts',
53	// Capability required
54	'custom-order-' . $post_type_slug,
55	// Menu and page slug
56	[$this, 'custom_order_page_output'],
57	// Callback function that outputs page content
58	9999
59	);
60	// Add the actual, functional 'Order' submenu page at /edit.php?post_type=sfwd-courses&page=custom-order-sfwd-courses
61	// We will redirect to this URL from /wp-admin/admin.php?page=custom-order-sfwd-courses created above using $this->maybe_perform_menu_link_redirects() hooked in admin_init
62	$hook_suffix = add_submenu_page(
63	'edit.php?post_type=' . $post_type_slug,
64	// Parent (menu) slug. Ref: https://developer.wordpress.org/reference/functions/add_submenu_page/#comment-1404
65	// 'learndash-lms', // Parent (menu) slug. Ref: https://developer.wordpress.org/reference/functions/add_submenu_page/#comment-1404
66	$post_type_name_plural . ' ' . __( 'Order', 'admin-site-enhancements' ),
67	// Page title
68	$post_type_name_plural . ' ' . __( 'Order', 'admin-site-enhancements' ),
69	// Menu title
70	'edit_others_posts',
71	// Capability required
72	'custom-order-' . $post_type_slug,
73	// Menu and page slug
74	[$this, 'custom_order_page_output'],
75	// Callback function that outputs page content
76	9999
77	);
78	} else {
79	$hook_suffix = add_submenu_page(
80	'edit.php?post_type=' . $post_type_slug,
81	// Parent (menu) slug. Ref: https://developer.wordpress.org/reference/functions/add_submenu_page/#comment-1404
82	$post_type_name_plural . ' Order',
83	// Page title
84	__( 'Order', 'admin-site-enhancements' ),
85	// Menu title
86	'edit_others_posts',
87	// Capability required
88	'custom-order-' . $post_type_slug,
89	// Menu and page slug
90	[$this, 'custom_order_page_output'],
91	// Callback function that outputs page content
92	9999
93	);
94	}
95	}
96	add_action( 'admin_print_styles-' . $hook_suffix, [$this, 'enqueue_content_order_styles'] );
97	add_action( 'admin_print_scripts-' . $hook_suffix, [$this, 'enqueue_content_order_scripts'] );
98	}
99	}
100	}
101	}
102	}
103
104	/**
105	* Add additinal HTML elements on list tables
106	*
107	* @since 7.6.10
108	*/
109	public function add_additional_elements() {
110	global $pagenow, $typenow;
111	$common_methods = new Common_Methods();
112	$options = get_option( ASENHA_SLUG_U, array() );
113	$content_order_for = ( isset( $options['content_order_for'] ) ? $options['content_order_for'] : array() );
114	$content_order_enabled_post_types = $common_methods->get_array_of_keys_with_true_value( $content_order_for );
115	$content_order_other_enabled_post_types = array();
116	// List tables of pages, posts and CPTs. Administrators and Editors only.
117	if ( 'edit.php' == $pagenow && current_user_can( 'edit_others_posts' ) && (in_array( $typenow, $content_order_enabled_post_types ) \|\| in_array( $typenow, $content_order_other_enabled_post_types )) ) {
118	// Add "Order" button
119	if ( 'post' == $typenow ) {
120	$typenow = 'posts';
121	}
122	?>
123	<div id="content-order-button">
124	<a class="button" href="<?php
125	echo esc_url( get_admin_url() );
126	?>edit.php?post_type=<?php
127	echo esc_attr( $typenow );
128	?>&page=custom-order-<?php
129	echo esc_attr( $typenow );
130	?>"><?php
131	_e( 'Order', 'admin-site-enhancements' );
132	?></a>
133	</div>
134	<?php
135	}
136	}
137
138	/**
139	* Add scripts for content list tables
140	*
141	* @since 7.6.10
142	*/
143	public function add_list_tables_scripts( $hook_suffix ) {
144	global $pagenow, $typenow;
145	$common_methods = new Common_Methods();
146	$options = get_option( ASENHA_SLUG_U, array() );
147	$content_order_for = ( isset( $options['content_order_for'] ) ? $options['content_order_for'] : array() );
148	$content_order_enabled_post_types = $common_methods->get_array_of_keys_with_true_value( $content_order_for );
149	$content_order_other_enabled_post_types = array();
150	// List tables of pages, posts and CPTs
151	if ( 'edit.php' == $hook_suffix && current_user_can( 'edit_others_posts' ) && (in_array( $typenow, $content_order_enabled_post_types ) \|\| in_array( $typenow, $content_order_other_enabled_post_types )) ) {
152	wp_enqueue_style(
153	'asenha-list-tables-content-order',
154	ASENHA_URL . 'assets/css/list-tables-content-order.css',
155	array(),
156	ASENHA_VERSION
157	);
158	wp_enqueue_script(
159	'asenha-list-tables-content-order',
160	ASENHA_URL . 'assets/js/list-tables-content-order.js',
161	array('jquery'),
162	ASENHA_VERSION,
163	false
164	);
165	}
166	}
167
168	/**
169	* Maybe perform redirects from the 'Order' submenu link
170	*
171	* @since 7.6.9
172	*/
173	public function maybe_perform_menu_link_redirects() {
174	$request_uri = sanitize_text_field( $_SERVER['REQUEST_URI'] );
175	// e.g. /wp-admin/index.php?page=page-slug
176	// Redirect for LearnDash LMS Courses post type ('sfwd-courses')
177	if ( in_array( 'sfwd-lms/sfwd_lms.php', get_option( 'active_plugins', array() ) ) ) {
178	if ( false !== strpos( $request_uri, 'admin.php?page=custom-order-sfwd-courses' ) ) {
179	wp_safe_redirect( get_admin_url() . 'edit.php?post_type=sfwd-courses&page=custom-order-sfwd-courses' );
180	exit;
181	}
182	}
183	}
184
185	/**
186	* Output content for the custom order page for each enabled post types
187	* Not using settings API because all done via AJAX
188	*
189	* @since 5.0.0
190	*/
191	public function custom_order_page_output() {
192	$post_status = array(
193	'publish',
194	'future',
195	'draft',
196	'pending',
197	'private'
198	);
199	$parent_slug = get_admin_page_parent();
200	if ( 'edit.php' == $parent_slug ) {
201	$post_type_slug = 'post';
202	} elseif ( 'upload.php' == $parent_slug ) {
203	$post_type_slug = 'attachment';
204	$post_status = array('inherit', 'private');
205	} else {
206	$post_type_slug = str_replace( 'edit.php?post_type=', '', $parent_slug );
207	}
208	// Object with properties for each post status and the count of posts for each status
209	// $post_count_object = wp_count_posts( $post_type_slug );
210	// Number of items with the status 'publish(ed)', 'future' (scheduled), 'draft', 'pending' and 'private'
211	// $post_count = absint( $post_count_object->publish )
212	// + absint( $post_count_object->future )
213	// + absint( $post_count_object->draft )
214	// + absint( $post_count_object->pending )
215	// + absint( $post_count_object->private );
216	?>
217	<div class="wrap">
218	<div class="page-header">
219	<h2>
220	<?php
221	echo esc_html( get_admin_page_title() );
222	?>
223	</h2>
224	<?php
225	?>
226	</div>
227	<?php
228	// Get posts
229	$args = array(
230	'post_type' => $post_type_slug,
231	'numberposts' => -1,
232	'orderby' => 'menu_order title',
233	'order' => 'ASC',
234	'post_status' => $post_status,
235	);
236	// Add the following to non-attachment post types
237	if ( 'attachment' != $post_type_slug && is_post_type_hierarchical( $post_type_slug ) ) {
238	// In hierarchical post types, only return non-child posts as we currently only sort parent posts
239	$args['post_parent'] = 0;
240	}
241	$posts = get_posts( $args );
242	if ( !empty( $posts ) ) {
243	?>
244	<ul id="item-list">
245	<?php
246	foreach ( $posts as $post ) {
247	$this->custom_order_single_item_output( $post );
248	}
249	?>
250	</ul>
251	<div id="updating-order-notice" class="updating-order-notice" style="display: none;"><img src="<?php
252	echo esc_attr( ASENHA_URL ) . 'assets/img/oval.svg';
253	?>" id="spinner-img" class="spinner-img" /><span class="dashicons dashicons-saved" style="display:none;"></span>Updating order...</div>
254	<?php
255	} else {
256	?>
257	<h3>There is nothing to sort for this post type.</h3>
258	<?php
259	}
260	?>
261	</div> <!-- End of div.wrap -->
262	<?php
263	}
264
265	/**
266	* Output single item sortable for custom content order
267	*
268	* @since 5.0.0
269	*/
270	private function custom_order_single_item_output( $post ) {
271	if ( is_post_type_hierarchical( $post->post_type ) ) {
272	$post_type_object = get_post_type_object( $post->post_type );
273	$children = get_pages( array(
274	'child_of' => $post->ID,
275	'post_type' => $post->post_type,
276	) );
277	if ( count( $children ) > 0 ) {
278	$has_child_label = '<span class="has-child-label"> <span class="dashicons dashicons-arrow-right"></span> Has child ' . strtolower( $post_type_object->label ) . '</span>';
279	$has_child = 'true';
280	} else {
281	$has_child_label = '';
282	$has_child = 'false';
283	}
284	} else {
285	$has_child_label = '';
286	$has_child = 'false';
287	}
288	$post_status_label_class = ( $post->post_status == 'publish' ? ' item-status-hidden' : '' );
289	$post_status_object = get_post_status_object( $post->post_status );
290	if ( 'attachment' == $post->post_type ) {
291	$post_status_label_separator = '';
292	$post_status_label = '';
293	// Attachments / media only has the post status 'inherit'. Let's not show it.
294	} else {
295	$post_status_label_separator = ' — ';
296	$post_status_label = $post_status_object->label;
297	}
298	if ( empty( wp_trim_excerpt( $post->post_excerpt, $post ) ) ) {
299	$short_excerpt = '';
300	} else {
301	$excerpt_trimmed = implode( " ", array_slice( explode( " ", wp_trim_excerpt( $post->post_excerpt, $post ) ), 0, 30 ) );
302	$short_excerpt = '<span class="item-excerpt"> \| ' . $excerpt_trimmed . '</span>';
303	}
304	$taxonomies = get_object_taxonomies( $post->post_type, 'objects' );
305	// vi( $taxonomies );
306	$taxonomies_and_terms = '';
307	foreach ( $taxonomies as $taxonomy ) {
308	$terms = array();
309	if ( $taxonomy->hierarchical ) {
310	$taxonomy_terms = get_the_terms( $post->ID, $taxonomy->name );
311	if ( is_array( $taxonomy_terms ) && !empty( $taxonomy_terms ) ) {
312	foreach ( $taxonomy_terms as $term ) {
313	$terms[] = $term->name;
314	}
315	}
316	}
317	$terms = implode( ', ', $terms );
318	$taxonomies_and_terms .= ' \| ' . $taxonomy->label . ': ' . $terms;
319	}
320	if ( !empty( $taxonomies_and_terms ) ) {
321	$taxonomies_and_terms = '<span class="item-taxonomy-terms">' . $taxonomies_and_terms . '</span>';
322	}
323	// If WPML plugin is active, let's get the current language
324	if ( in_array( 'sitepress-multilingual-cms/sitepress.php', get_option( 'active_plugins', array() ) ) ) {
325	$current_language = apply_filters( 'wpml_current_language', null );
326	$current_post_language_info = apply_filters( 'wpml_post_language_details', null, $post->ID );
327	if ( !is_wp_error( $current_post_language_info ) ) {
328	$current_post_language = $current_post_language_info['language_code'];
329	} else {
330	// wpml has not set language information for the post
331	// e.g. post is not translated yet, so, let's use the current site/admin language
332	$current_post_language = $current_language;
333	}
334	$same_language = $current_language === $current_post_language;
335	// true if language is the same, false otherwise
336	} else {
337	// WPML is not active, $same_language is always true, e.g. all posts are in English
338	$same_language = true;
339	}
340	// Only render sortable for posts that have the same language as the current chosen language
341	if ( $same_language ) {
342	?>
343	<li id="list_<?php
344	echo esc_attr( $post->ID );
345	?>" class="list-item" data-id="<?php
346	echo esc_attr( $post->ID );
347	?>" data-menu-order="<?php
348	echo esc_attr( $post->menu_order );
349	?>" data-parent="<?php
350	echo esc_attr( $post->post_parent );
351	?>" data-has-child="<?php
352	echo esc_attr( $has_child );
353	?>" data-post-type="<?php
354	echo esc_attr( $post->post_type );
355	?>">
356	<div class="row">
357	<div class="row-content">
358	<?php
359	echo '<div class="content-main">
360	<span class="dashicons dashicons-menu"></span><a href="' . esc_attr( get_edit_post_link( $post->ID ) ) . '" class="item-title">' . esc_html( $post->post_title ) . '</a><span class="item-status' . esc_attr( $post_status_label_class ) . '">' . esc_html( $post_status_label_separator ) . esc_html( $post_status_label ) . '</span>' . wp_kses_post( $has_child_label ) . wp_kses_post( $taxonomies_and_terms ) . wp_kses_post( $short_excerpt ) . '<div class="fader"></div>
361	</div>';
362	if ( !in_array( $post->post_type, array('asenha_code_snippet') ) ) {
363	echo '<div class="content-additional">
364	<a href="' . esc_attr( get_the_permalink( $post->ID ) ) . '" target="_blank" class="button item-view-link">View</a>
365	</div>';
366	}
367	?>
368	</div>
369	</div>
370	<?php
371	}
372	// if ( $same_language )
373	?>
374	</li>
375	<?php
376	}
377
378	/**
379	* Enqueue styles for content order pages
380	*
381	* @since 5.0.0
382	*/
383	public function enqueue_content_order_styles() {
384	wp_enqueue_style(
385	'content-order-style',
386	ASENHA_URL . 'assets/css/content-order.css',
387	array(),
388	ASENHA_VERSION
389	);
390	}
391
392	/**
393	* Enqueue scripts for content order pages
394	*
395	* @since 5.0.0
396	*/
397	public function enqueue_content_order_scripts() {
398	global $typenow;
399	wp_enqueue_script(
400	'content-order-jquery-ui-touch-punch',
401	ASENHA_URL . 'assets/js/jquery.ui.touch-punch.min.js',
402	array('jquery-ui-sortable'),
403	'0.2.3',
404	true
405	);
406	wp_register_script(
407	'content-order-nested-sortable',
408	ASENHA_URL . 'assets/js/jquery.mjs.nestedSortable.js',
409	array('content-order-jquery-ui-touch-punch'),
410	'2.0.0',
411	true
412	);
413	wp_enqueue_script(
414	'content-order-sort',
415	ASENHA_URL . 'assets/js/content-order-sort.js',
416	array('content-order-nested-sortable'),
417	ASENHA_VERSION,
418	true
419	);
420	wp_localize_script( 'content-order-sort', 'contentOrderSort', array(
421	'action' => 'save_custom_order',
422	'nonce' => wp_create_nonce( 'order_sorting_nonce' ),
423	'hirarchical' => ( is_post_type_hierarchical( $typenow ) ? 'true' : 'false' ),
424	) );
425	}
426
427	/**
428	* Save custom content order coming from ajax call
429	*
430	* @since 5.0.0
431	*/
432	public function save_custom_content_order() {
433	global $wpdb;
434	// Check user capabilities
435	if ( !current_user_can( 'edit_others_posts' ) ) {
436	wp_send_json( 'Something went wrong.' );
437	}
438	// Verify nonce
439	if ( !wp_verify_nonce( $_POST['nonce'], 'order_sorting_nonce' ) ) {
440	wp_send_json( 'Something went wrong.' );
441	}
442	// Get ajax variables
443	$action = ( isset( $_POST['action'] ) ? $_POST['action'] : '' );
444	// Item parent is currently 0, as we only handle sorting of non-child posts
445	$item_parent = ( isset( $_POST['item_parent'] ) ? absint( $_POST['item_parent'] ) : 0 );
446	$menu_order_start = ( isset( $_POST['start'] ) ? absint( $_POST['start'] ) : 0 );
447	$post_id = ( isset( $_POST['post_id'] ) ? absint( $_POST['post_id'] ) : 0 );
448	$item_menu_order = ( isset( $_POST['menu_order'] ) ? absint( $_POST['menu_order'] ) : 0 );
449	$items_to_exclude = ( isset( $_POST['excluded_items'] ) ? absint( $_POST['excluded_items'] ) : array() );
450	$post_type = ( isset( $_POST['post_type'] ) ? $_POST['post_type'] : false );
451	// Make processing faster by removing certain actions
452	remove_action( 'pre_post_update', 'wp_save_post_revision' );
453	// $response array for ajax response
454	$response = array();
455	// Update the item whose order/position was moved
456	if ( $post_id > 0 && !isset( $_POST['more_posts'] ) ) {
457	$wpdb->update(
458	$wpdb->posts,
459	// The table
460	array(
461	'menu_order' => $item_menu_order,
462	),
463	array(
464	'ID' => $post_id,
465	)
466	);
467	clean_post_cache( $post_id );
468	$items_to_exclude[] = $post_id;
469	}
470	if ( 'attachment' == $post_type ) {
471	$post_status = array('inherit', 'private');
472	} else {
473	$post_status = array(
474	'publish',
475	'future',
476	'draft',
477	'pending',
478	'private'
479	);
480	}
481	// Get all posts from the post type related to ajax request
482	$query_args = array(
483	'post_type' => $post_type,
484	'orderby' => 'menu_order title',
485	'order' => 'ASC',
486	'posts_per_page' => -1,
487	'suppress_filters' => true,
488	'ignore_sticky_posts' => true,
489	'post_status' => $post_status,
490	'post__not_in' => $items_to_exclude,
491	'update_post_term_cache' => false,
492	'update_post_meta_cache' => false,
493	);
494	if ( 'attachment' == $post_type ) {
495	// do nothing, we do not add post_parent parameter as media items can be attached to other posts, making them the parent.
496	} else {
497	// Item parent is currently 0, as we only handle sorting of non-child posts
498	$query_args['post_parent'] = $item_parent;
499	}
500	$posts = new WP_Query($query_args);
501	if ( $posts->have_posts() ) {
502	// Iterate through posts and update menu order and post parent
503	foreach ( $posts->posts as $post ) {
504	// If the $post is the one being displaced (shited downward) by the moved item, increment it's menu_order by one
505	if ( $menu_order_start == $item_menu_order && $post_id > 0 ) {
506	$menu_order_start++;
507	}
508	// Only process posts other than the moved item, which has been processed earlier outside this loop
509	if ( $post_id != $post->ID ) {
510	// Update menu_order
511	$wpdb->update( $wpdb->posts, array(
512	'menu_order' => $menu_order_start,
513	), array(
514	'ID' => $post->ID,
515	) );
516	clean_post_cache( $post->ID );
517	}
518	$items_to_exclude[] = $post->ID;
519	$menu_order_start++;
520	}
521	die( json_encode( $response ) );
522	} else {
523	die( json_encode( $response ) );
524	}
525	}
526
527	/**
528	* Set default ordering of list tables of sortable post types by 'menu_order'
529	*
530	* @link https://developer.wordpress.org/reference/classes/wp_query/#methods
531	* @since 5.0.0
532	*/
533	public function orderby_menu_order( $query ) {
534	global $pagenow, $typenow;
535	$query_post_type = $query->get( 'post_type' );
536	$options = get_option( ASENHA_SLUG_U, array() );
537	// Hierarchical post types that should be custom ordered
538	$content_order_for = ( isset( $options['content_order_for'] ) ? $options['content_order_for'] : array() );
539	$content_order_enabled_post_types = array();
540	if ( is_array( $content_order_for ) && count( $content_order_for ) > 0 ) {
541	foreach ( $content_order_for as $post_type_slug => $is_custom_order_enabled ) {
542	if ( $is_custom_order_enabled ) {
543	$content_order_enabled_post_types[] = $post_type_slug;
544	}
545	}
546	}
547	$should_be_custom_sorted = false;
548	// All post types that should be custom ordered
549	$content_order_post_types = $content_order_enabled_post_types;
550	// Use custom order in wp-admin listing pages/tables for enabled post types
551	if ( is_admin() && ('edit.php' == $pagenow \|\| 'upload.php' == $pagenow) && !isset( $_GET['orderby'] ) ) {
552	if ( in_array( $typenow, $content_order_post_types ) ) {
553	$query->set( 'orderby', 'menu_order title' );
554	$query->set( 'order', 'ASC' );
555	}
556	}
557	}
558
559	/**
560	* Make sure newly created posts are assigned the highest menu_order so it's added at the bottom of the existing order
561	*
562	* @since 6.2.1
563	*/
564	public function set_menu_order_for_new_posts( $post_id, $post, $update ) {
565	$options = get_option( ASENHA_SLUG_U, array() );
566	$content_order_for = ( isset( $options['content_order_for'] ) ? $options['content_order_for'] : array() );
567	$content_order_enabled_post_types = array();
568	if ( is_array( $content_order_for ) && count( $content_order_for ) > 0 ) {
569	foreach ( $content_order_for as $post_type_slug => $is_custom_order_enabled ) {
570	if ( $is_custom_order_enabled ) {
571	$content_order_enabled_post_types[] = $post_type_slug;
572	}
573	}
574	}
575	// Only assign menu_order if there are none assigned when creating the post, i.e. menu_order is 0
576	if ( in_array( $post->post_type, $content_order_enabled_post_types ) && ('auto-draft' == $post->post_status \|\| 'publish' == $post->post_status) && $post->menu_order == '0' && false === $update ) {
577	$post_with_highest_menu_order = get_posts( array(
578	'post_type' => $post->post_type,
579	'posts_per_page' => 1,
580	'orderby' => 'menu_order',
581	'order' => 'DESC',
582	) );
583	if ( $post_with_highest_menu_order ) {
584	$new_menu_order = (int) $post_with_highest_menu_order[0]->menu_order + 1;
585	// Assign the one higher menu_order to the new post
586	$args = array(
587	'ID' => $post_id,
588	'menu_order' => $new_menu_order,
589	);
590	wp_update_post( $args );
591	}
592	}
593	}
594
595	}
596