Add job overlay to admin (#2804)

Author: yscik

.psalm/psalm-baseline.xml

@@ -74,9 +74,6 @@
       <code>WP_Job_manager</code>
       <code>WP_Job_manager</code>
     </InvalidClass>
-    <ParadoxicalCondition>
-      <code><![CDATA[! defined( 'ABSPATH' )]]></code>
-    </ParadoxicalCondition>
   </file>
   <file src="includes/admin/class-wp-job-manager-cpt.php">
     <InvalidArgument>
@@ -219,7 +216,6 @@
   <file src="includes/class-wp-job-manager-post-types.php">
     <InvalidArgument>
       <code>$job_data</code>
-      <code>$pending_jobs</code>
       <code><![CDATA[[
 				apply_filters(
 					'register_post_type_job_guest_user',

assets/css/admin.scss

@@ -99,6 +99,12 @@ a.wpjm-activate-license-link:active {
 	}
 }
 
+.column-stats {
+	a {
+		display: block;
+	}
+}
+
 /** Promote Job Modal **/
 .promote-buttons-group {
 	.button {

assets/css/job-overlay.scss

@@ -79,6 +79,10 @@
 		flex-wrap: wrap;
 	}
 
+	&:empty {
+		display: none;
+	}
+
 }
 
 .jm-job-overlay-details-box {

assets/js/job-dashboard.js

@@ -30,7 +30,10 @@ async function showOverlay( eventOrId ) {
 	eventOrId.preventDefault?.();
 	overlayDialog.showModal();
 
-	const id = eventOrId.target?.dataset.jobId ?? eventOrId;
+	const dashboardRowId = eventOrId.target?.dataset.jobId;
+	const adminRowId = eventOrId.target?.closest( 'tr' )?.id?.replace( 'post-', '' );
+
+	const id = dashboardRowId ?? adminRowId ?? eventOrId;
 
 	if ( ! id ) {
 		return;
@@ -42,7 +45,7 @@ async function showOverlay( eventOrId ) {
 	contentElement.innerHTML = '<a class="jm-ui-spinner"></a>';
 
 	try {
-		const response = await fetch( `${ overlayEndpoint }?job_id=${ id }` );
+		const response = await fetch( `${ overlayEndpoint }&job_id=${ id }` );
 
 		if ( ! response.ok ) {
 			throw new Error( response.statusText );
@@ -56,7 +59,7 @@ async function showOverlay( eventOrId ) {
 	}
 
 	const clearHash = () => {
-		history.replaceState( null, '', window.location.pathname );
+		history.replaceState( null, '', window.location.pathname + window.location.search );
 		overlayDialog.removeEventListener( 'close', clearHash );
 	};
 
@@ -67,7 +70,7 @@ async function showOverlay( eventOrId ) {
 
 function setupStatsOverlay() {
 	document
-		.querySelectorAll( '.jm-dashboard-job .job-title' )
+		.querySelectorAll( '.jm-dashboard-job .job-title, tr.job_listing td.column-stats' )
 		.forEach( el => el.addEventListener( 'click', showOverlay ) );
 
 	const urlHash = window.location.hash?.substring( 1 );

includes/admin/class-wp-job-manager-admin.php

@@ -5,6 +5,8 @@
  * @package wp-job-manager
  */
 
+use WP_Job_Manager\Job_Overlay;
+
 if ( ! defined( 'ABSPATH' ) ) {
 	exit;
 }
@@ -64,6 +66,7 @@ public function __construct() {
 
 		$this->settings_page = WP_Job_Manager_Settings::instance();
 		WP_Job_Manager_Addons_Landing_Page::instance();
+		Job_Overlay::instance();
 
 		add_action( 'admin_init', [ $this, 'admin_init' ] );
 		add_action( 'current_screen', [ $this, 'conditional_includes' ] );

includes/admin/class-wp-job-manager-cpt.php

@@ -263,7 +263,7 @@ public function approve_job() {
 				'post_status' => 'publish',
 			];
 			wp_update_post( $job_data );
-			wp_safe_redirect( remove_query_arg( 'approve_job', add_query_arg( 'handled_jobs', $post_id, add_query_arg( 'action_performed', 'approve_jobs', admin_url( 'edit.php?post_type=job_listing' ) ) ) ) );
+			wp_safe_redirect( remove_query_arg( 'approve_job', add_query_arg( [ 'handled_jobs' => [ $post_id ] ], add_query_arg( 'action_performed', 'approve_jobs', admin_url( 'edit.php?post_type=job_listing' ) ) ) ) );
 			exit;
 		}
 	}
@@ -545,39 +545,7 @@ public function row_actions( $actions, $post ) {
 			unset( $actions['inline hide-if-no-js'] );
 			unset( $actions['trash'] );
 
-			$admin_actions = [];
-
-			if ( in_array( $post->post_status, [ 'pending', 'pending_payment' ], true ) && current_user_can( 'publish_post', $post->ID ) ) {
-				$admin_actions['approve'] = [
-					'action' => 'approved',
-					'name'   => __( 'Approve', 'wp-job-manager' ),
-					'url'    => wp_nonce_url( add_query_arg( 'approve_job', $post->ID ), 'approve_job' ),
-				];
-			}
-			if ( 'trash' !== $post->post_status ) {
-				if ( current_user_can( 'read_post', $post->ID ) ) {
-					$admin_actions['view'] = [
-						'action' => 'view',
-						'name'   => __( 'View', 'wp-job-manager' ),
-						'url'    => get_permalink( $post->ID ),
-					];
-				}
-				if ( current_user_can( 'edit_post', $post->ID ) ) {
-					$admin_actions['edit'] = [
-						'action' => 'edit',
-						'name'   => __( 'Edit', 'wp-job-manager' ),
-						'url'    => get_edit_post_link( $post->ID ),
-					];
-				}
-				if ( current_user_can( 'delete_post', $post->ID ) ) {
-					$admin_actions['delete'] = [
-						'action' => 'delete',
-						'name'   => __( 'Delete', 'wp-job-manager' ),
-						'url'    => get_delete_post_link( $post->ID ),
-					];
-				}
-			}
-			$admin_actions = apply_filters( 'job_manager_admin_actions', $admin_actions, $post );
+			$admin_actions = $this->get_admin_actions( $post );
 
 			foreach ( $admin_actions as $action ) {
 				$actions[ $action['action'] ] = '<a href="' . esc_url( $action['url'] ) . '" title="" rel="permalink">' . esc_html( $action['name'] ) . '</a>';
@@ -587,6 +555,49 @@ public function row_actions( $actions, $post ) {
 		return $actions;
 	}
 
+	/**
+	 * Get the admin actions for a job listing.
+	 *
+	 * @param \WP_Post $post
+	 *
+	 * @return array
+	 */
+	public function get_admin_actions( $post ) {
+		$admin_actions = [];
+
+		if ( in_array( $post->post_status, [ 'pending', 'pending_payment' ], true ) && current_user_can( 'publish_post', $post->ID ) ) {
+			$admin_actions['approve'] = [
+				'action' => 'approved',
+				'name'   => __( 'Approve', 'wp-job-manager' ),
+				'url'    => wp_nonce_url( add_query_arg( 'approve_job', $post->ID ), 'approve_job' ),
+			];
+		}
+		if ( 'trash' !== $post->post_status ) {
+			if ( current_user_can( 'read_post', $post->ID ) ) {
+				$admin_actions['view'] = [
+					'action' => 'view',
+					'name'   => __( 'View', 'wp-job-manager' ),
+					'url'    => get_permalink( $post->ID ),
+				];
+			}
+			if ( current_user_can( 'edit_post', $post->ID ) ) {
+				$admin_actions['edit'] = [
+					'action' => 'edit',
+					'name'   => __( 'Edit', 'wp-job-manager' ),
+					'url'    => get_edit_post_link( $post->ID ),
+				];
+			}
+			if ( current_user_can( 'delete_post', $post->ID ) ) {
+				$admin_actions['delete'] = [
+					'action' => 'delete',
+					'name'   => __( 'Delete', 'wp-job-manager' ),
+					'url'    => get_delete_post_link( $post->ID ),
+				];
+			}
+		}
+		return apply_filters( 'job_manager_admin_actions', $admin_actions, $post );
+	}
+
 	/**
 	 * Displays the content for each custom column on the admin list for Job Listings.
 	 *

includes/class-job-dashboard-shortcode.php

@@ -8,6 +8,7 @@
 namespace WP_Job_Manager;
 
 use WP_Job_Manager\UI\Notice;
+use WP_Job_Manager\UI\Redirect_Message;
 use WP_Job_Manager\UI\UI_Elements;
 
 if ( ! defined( 'ABSPATH' ) ) {
@@ -100,9 +101,7 @@ public function output_job_dashboard( $attrs ) {
 		);
 		$posts_per_page = $attrs['posts_per_page'];
 
-		\WP_Job_Manager::register_style( 'wp-job-manager-job-dashboard', 'css/job-dashboard.css', [ 'wp-job-manager-ui' ] );
-		wp_enqueue_style( 'wp-job-manager-job-dashboard' );
-		wp_enqueue_script( 'wp-job-manager-job-dashboard' );
+		Job_Overlay::instance()->init_dashboard_overlay();
 
 		ob_start();
 
@@ -134,7 +133,12 @@ public function output_job_dashboard( $attrs ) {
 		// Cache IDs for access check later on.
 		$this->job_dashboard_job_ids = wp_list_pluck( $jobs->posts, 'ID' );
 
-		echo '<div class="alignwide">' . wp_kses_post( $this->job_dashboard_message ) . '</div>';
+		$message = Redirect_Message::get_message( 'updated' );
+
+		if ( ! empty( $message ) ) {
+			//phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped in the notice class.
+			echo '<div class="alignwide">' . $message . '</div>';
+		}
 
 		$job_dashboard_columns = apply_filters(
 			'job_manager_job_dashboard_columns',
@@ -160,6 +164,8 @@ public function output_job_dashboard( $attrs ) {
 			]
 		);
 
+		do_action( 'job_manager_job_dashboard', $jobs );
+
 		return ob_get_clean();
 	}
 
@@ -171,18 +177,16 @@ public function output_job_dashboard( $attrs ) {
 	 * @return array
 	 */
 	public function get_job_actions( $job ) {
-		if (
-			! get_current_user_id()
-			|| ! $job instanceof \WP_Post
-			|| \WP_Job_Manager_Post_Types::PT_LISTING !== $job->post_type
-			|| ! $this->is_job_available_on_dashboard( $job )
-		) {
+		if ( ! $this->can_manage_job( $job ) ) {
 			return [];
 		}
 
+		$base_url = self::get_job_dashboard_page_url();
+
 		$base_nonce_action_name = 'job_manager_my_job_actions';
 
 		$actions = [];
+
 		switch ( $job->post_status ) {
 			case 'publish':
 				if ( \WP_Job_Manager_Post_Types::job_is_editable( $job->ID ) ) {
@@ -262,7 +266,7 @@ public function get_job_actions( $job ) {
 
 		// For backwards compatibility, convert `nonce => true` to the nonce action name.
 		foreach ( $actions as $key => &$action ) {
-			if ( true === $action['nonce'] ) {
+			if ( isset( $action['nonce'] ) && true === $action['nonce'] ) {
 				$action['nonce'] = $base_nonce_action_name;
 			}
 
@@ -510,6 +514,8 @@ public function handle_actions() {
 			$this->job_dashboard_message = Notice::error( $e->getMessage() );
 		}
 
+		Redirect_Message::redirect( remove_query_arg( [ 'action', 'job_id', '_wpnonce' ] ), $this->job_dashboard_message, 'updated' );
+
 	}
 
 	/**
@@ -665,6 +671,27 @@ public static function get_job_dashboard_page_url() {
 		}
 	}
 
+	/**
+	 * Check if the current user can manage this job listing.
+	 *
+	 * @param \WP_Post|null $job
+	 *
+	 * @return bool
+	 */
+	public function can_manage_job( $job ) {
+
+		if ( ! get_current_user_id()
+			|| empty( $job )
+			|| ! $job instanceof \WP_Post
+			|| \WP_Job_Manager_Post_Types::PT_LISTING !== $job->post_type ) {
+			return false;
+		}
+
+		return is_admin()
+			? current_user_can( \WP_Job_Manager_Post_Types::CAP_MANAGE_LISTINGS, $job->ID )
+			: $this->is_job_available_on_dashboard( $job );
+	}
+
 	/**
 	 * Check if a job is listed on the current user's job dashboard page.
 	 *

includes/class-job-overlay.php

@@ -9,6 +9,8 @@
 
 use WP_Job_Manager\UI\Modal_Dialog;
 use WP_Job_Manager\UI\Notice;
+use WP_Job_Manager\UI\UI;
+use WP_Job_Manager\UI\UI_Elements;
 
 if ( ! defined( 'ABSPATH' ) ) {
 	exit;
@@ -28,21 +30,39 @@ class Job_Overlay {
 	 */
 	public function __construct() {
 		add_action( 'job_manager_ajax_job_dashboard_overlay', [ $this, 'ajax_job_overlay' ] );
+		add_action( 'wp_ajax_job_dashboard_overlay', [ $this, 'ajax_job_overlay' ] );
+		add_action( 'admin_footer', [ $this, 'init_admin_dashboard_overlay' ], 10 );
+		add_action( 'job_manager_job_dashboard', [ $this, 'init_dashboard_overlay' ], 10 );
+		add_action( 'job_manager_job_overlay_footer', [ $this, 'output_footer_actions' ], 10 );
 
 	}
 
 	/**
 	 * Render the job dashboard overlay content for an AJAX request.
 	 */
 	public function ajax_job_overlay() {
-		// phpcs:ignore WordPress.Security.NonceVerification.Recommended
+
+		// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Nonce check.
+		if ( ! isset( $_REQUEST['_wpnonce'] ) || ! wp_verify_nonce( wp_unslash( $_REQUEST['_wpnonce'] ), 'job_dashboard_overlay' ) ) {
+			wp_send_json_error(
+				Notice::error(
+					[
+						'message' => __( 'Invalid request.', 'wp-job-manager' ),
+						'classes' => [ 'type-dialog' ],
+					]
+				)
+			);
+
+			return;
+		}
+
 		$job_id = isset( $_REQUEST['job_id'] ) ? absint( $_REQUEST['job_id'] ) : null;
 
 		$job = $job_id ? get_post( $job_id ) : null;
 
 		$shortcode = Job_Dashboard_Shortcode::instance();
 
-		if ( empty( $job ) || ! $shortcode->is_job_available_on_dashboard( $job ) ) {
+		if ( ! $shortcode->can_manage_job( $job ) ) {
 			wp_send_json_error(
 				Notice::error(
 					[
@@ -55,7 +75,7 @@ public function ajax_job_overlay() {
 			return;
 		}
 
-		$content = $this->get_job_overlay( $job );
+		$content = $this->render_job_overlay( $job );
 
 		wp_send_json_success( $content );
 
@@ -65,6 +85,11 @@ public function ajax_job_overlay() {
 	 * Output the modal element.
 	 */
 	public function output_modal_element() {
+
+		UI::instance()->enqueue_styles();
+		wp_enqueue_style( 'wp-job-manager-job-dashboard' );
+		wp_enqueue_script( 'wp-job-manager-job-dashboard' );
+
 		$overlay = new Modal_Dialog(
 			[
 				'id'    => 'jmDashboardOverlay',
@@ -83,17 +108,14 @@ public function output_modal_element() {
 	 *
 	 * @return string
 	 */
-	private function get_job_overlay( $job ) {
-
-		$job_actions = Job_Dashboard_Shortcode::instance()->get_job_actions( $job );
+	private function render_job_overlay( $job ) {
 
 		ob_start();
 
 		get_job_manager_template(
 			'job-dashboard-overlay.php',
 			[
-				'job'         => $job,
-				'job_actions' => $job_actions,
+				'job' => $job,
 			]
 		);
 
@@ -102,5 +124,96 @@ private function get_job_overlay( $job ) {
 		return $content;
 	}
 
+	/**
+	 * Load and output overlay dependencies on the job listings screen.
+	 *
+	 * @output Modal HTML.
+	 *
+	 * @return void
+	 */
+	public function init_admin_dashboard_overlay() {
+		$screen = get_current_screen();
+
+		if ( ! $screen || 'edit-job_listing' !== $screen->id ) {
+			return;
+		}
+
+		$this->init_dashboard_overlay();
+	}
+
+	/**
+	 * Load scripts and output HTML skeleton for the job dashboard overlay.
+	 *
+	 * @output Modal HTML.
+	 *
+	 * @return void
+	 */
+	public function init_dashboard_overlay() {
+
+		\WP_Job_Manager::register_script( 'wp-job-manager-job-dashboard', 'js/job-dashboard.js', null, true );
+		\WP_Job_Manager::register_style( 'wp-job-manager-job-dashboard', 'css/job-dashboard.css', [ 'wp-job-manager-ui' ] );
+
+		$endpoint = is_admin()
+			? add_query_arg( [ 'action' => 'job_dashboard_overlay' ], admin_url( 'admin-ajax.php' ) )
+			: \WP_Job_Manager_Ajax::get_endpoint( 'job_dashboard_overlay' );
+		$endpoint = wp_nonce_url( $endpoint, 'job_dashboard_overlay' );
+
+		wp_localize_script(
+			'wp-job-manager-job-dashboard',
+			'job_manager_job_dashboard',
+			[
+				'i18nConfirmDelete' => esc_html__( 'Are you sure you want to delete this listing?', 'wp-job-manager' ),
+				'overlayEndpoint'   => $endpoint,
+				'statsEnabled'      => \WP_Job_Manager\Stats::is_enabled(),
+			]
+		);
+
+		$this->output_modal_element();
+	}
+
+	/**
+	 * Output the job actions in the overlay footer.
+	 *
+	 * @param \WP_Post $job
+	 */
+	public function output_footer_actions( $job ) {
+
+		if ( is_admin() ) {
+			return;
+		}
+
+		$job_actions = Job_Dashboard_Shortcode::instance()->get_job_actions( $job );
+
+		$buttons = [];
+		$actions = [];
+		if ( ! empty( $job_actions ) ) {
+			$primary = Job_Dashboard_Shortcode::get_primary_action( $job, $job_actions );
+
+			if ( $primary ) {
+				$buttons[] = [
+					'label'   => $primary['label'],
+					'url'     => $primary['url'],
+					'class'   => 'job-dashboard-action-' . esc_attr( $primary['name'] ),
+					'primary' => false,
+				];
+			}
+
+			foreach ( $job_actions as $action ) {
+				if ( ! empty( $primary ) && $primary['name'] === $action['name'] ) {
+					continue;
+				}
+				$actions[] = [
+					'label' => $action['label'],
+					'url'   => $action['url'],
+					'class' => 'job-dashboard-action-' . esc_attr( $action['name'] ),
+				];
+			}
+		}
+
+		// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped in UI classes.
+		echo UI_Elements::actions( $buttons, $actions );
+
+	}
+
 
 }

includes/class-stats-dashboard.php

@@ -35,8 +35,8 @@ private function __construct() {
 		add_filter( 'job_manager_job_dashboard_columns', [ $this, 'add_stats_column' ] );
 		add_action( 'job_manager_job_dashboard_column_' . self::COLUMN_NAME, [ $this, 'render_stats_column' ] );
 
-		add_filter( 'manage_edit-job_listing_columns', [ $this, 'add_stats_column' ], 20 );
-		add_action( 'manage_job_listing_posts_custom_column', [ $this, 'maybe_render_job_listing_posts_custom_column' ], 2 );
+		add_filter( 'manage_edit-job_listing_columns', [ $this, 'add_stats_column' ] );
+		add_action( 'manage_job_listing_posts_custom_column', [ $this, 'maybe_render_admin_stats_column' ], 2 );
 
 		add_action( 'job_manager_job_overlay_content', [ $this, 'output_job_stats' ], 12 );
 	}
@@ -77,11 +77,13 @@ public function render_stats_column( $job ) {
 	 *
 	 * @param string $column
 	 */
-	public function maybe_render_job_listing_posts_custom_column( $column ) {
+	public function maybe_render_admin_stats_column( $column ) {
 		global $post;
 
-		if ( self::COLUMN_NAME === $column ) {
+		if ( self::COLUMN_NAME === $column && ! empty( $post->ID ) ) {
+			echo '<a href="#' . esc_attr( $post->ID ) . ' ">';
 			$this->render_stats_column( $post );
+			echo '</a>';
 		}
 	}
 

includes/class-wp-job-manager.php

@@ -6,6 +6,8 @@
  * @since   1.33.0
  */
 
+use WP_Job_Manager\Job_Overlay;
+
 if ( ! defined( 'ABSPATH' ) ) {
 	exit;
 }
@@ -540,7 +542,6 @@ public function frontend_scripts() {
 
 		wp_register_script( 'jquery-deserialize', JOB_MANAGER_PLUGIN_URL . '/assets/lib/jquery-deserialize/jquery.deserialize.js', [ 'jquery' ], '1.2.1', true );
 		self::register_script( 'wp-job-manager-ajax-filters', 'js/ajax-filters.js', $ajax_filter_deps, true );
-		self::register_script( 'wp-job-manager-job-dashboard', 'js/job-dashboard.js', null, true );
 		self::register_script( 'wp-job-manager-job-application', 'js/job-application.js', [ 'jquery' ], true );
 		self::register_script( 'wp-job-manager-job-submission', 'js/job-submission.js', [ 'jquery' ], true );
 		wp_localize_script( 'wp-job-manager-ajax-filters', 'job_manager_ajax_filters', $ajax_data );
@@ -571,15 +572,7 @@ public function frontend_scripts() {
 			]
 		);
 
-		wp_localize_script(
-			'wp-job-manager-job-dashboard',
-			'job_manager_job_dashboard',
-			[
-				'i18nConfirmDelete' => esc_html__( 'Are you sure you want to delete this listing?', 'wp-job-manager' ),
-				'overlayEndpoint'   => WP_Job_Manager_Ajax::get_endpoint( 'job_dashboard_overlay' ),
-				'statsEnabled'      => \WP_Job_Manager\Stats::is_enabled(),
-			]
-		);
+		Job_Overlay::instance()->init_dashboard_overlay();
 
 		wp_localize_script(
 			'wp-job-manager-job-submission',

psalm.xml

@@ -29,11 +29,11 @@
 				<referencedClass name="WP_CLI" />
 			</errorLevel>
 		</UndefinedClass>
-		<InvalidScalarArgument>
+		<InvalidArgument>
 			<errorLevel type="suppress">
 				<referencedFunction name="esc_attr" />
 			</errorLevel>
-		</InvalidScalarArgument>
+		</InvalidArgument>
 	</issueHandlers>
 	<stubs>
 		<file name="wp-job-manager.php" />

templates/job-dashboard-overlay.php

@@ -9,7 +9,6 @@
  * @version     $$next-version$$
  *
  * @var WP_Post $job Array of job post results.
- * @var array   $job_actions
  */
 
 use WP_Job_Manager\Job_Dashboard_Shortcode;
@@ -58,35 +57,5 @@
 		<?php do_action( 'job_manager_job_overlay_content', $job ); ?>
 
 	</div>
-	<div class="jm-job-overlay-footer">
-		<?php
-		$buttons = [];
-		$actions = [];
-		if ( ! empty( $job_actions ) ) {
-			$primary = Job_Dashboard_Shortcode::get_primary_action( $job, $job_actions );
-
-			if ( $primary ) {
-				$buttons[] = [
-					'label' => $primary['label'],
-					'url'   => $primary['url'],
-					'class' => 'job-dashboard-action-' . esc_attr( $primary['name'] ),
-					'primary' => false,
-				];
-			}
-
-			foreach ( $job_actions as $action ) {
-				if ( ! empty( $primary ) && $primary['name'] === $action['name'] ) {
-					continue;
-				}
-				$actions[] = [
-					'label' => $action['label'],
-					'url'   => $action['url'],
-					'class' => 'job-dashboard-action-' . esc_attr( $action['name'] ),
-				];
-			}
-		}
-
-		echo UI_Elements::actions( $buttons, $actions );
-		?>
-	</div>
+	<div class="jm-job-overlay-footer"><?php do_action( 'job_manager_job_overlay_footer', $job ); ?></div>
 </div>

templates/job-dashboard.php

@@ -100,6 +100,4 @@ class="jm-dashboard-job-column <?php echo esc_attr( $key ); ?>"><?php echo esc_h
 		<?php endif; ?>
 	</div>
 	<?php get_job_manager_template( 'pagination.php', [ 'max_num_pages' => $max_num_pages ] ); ?>
-
-	<?php Job_Overlay::instance()->output_modal_element(); ?>
 </div>