Stop saving prpl_popover_id as a post-meta

aristath · aristath · commit d2c0c56c7df1 · 2025-09-11T11:07:43.000+03:00
diff --git a/classes/class-suggested-tasks-db.php b/classes/class-suggested-tasks-db.php
@@ -175,7 +175,6 @@ public function update_recommendation( $id, $data ) {
 			switch ( $key ) {
 				case 'points':
 				case 'prpl_points':
-				case 'prpl_popover_id':
 				case 'prpl_external_link_url':
 					$update_meta[ 'prpl_' . \str_replace( 'prpl_', '', (string) $key ) ] = $value;
 					break;
diff --git a/classes/class-suggested-tasks.php b/classes/class-suggested-tasks.php
@@ -314,11 +314,6 @@ public function register_post_type() {
 				'show_in_rest' => true,
 				'default'      => 0,
 			],
-			'prpl_popover_id'        => [
-				'type'         => 'string',
-				'single'       => true,
-				'show_in_rest' => true,
-			],
 			'prpl_external_link_url' => [
 				'type'         => 'string',
 				'single'       => true,
@@ -450,6 +445,9 @@ public function rest_prepare_recommendation( $response, $post ) {
 				? \esc_url( (string) $response->data['meta']['prpl_url'] )
 				: '';
 
+			$response->data['prpl_popover_id'] = $provider->get_popover_id();
+
+			// This has to be the last item to be added because actions use data from previous items.
 			$response->data['prpl_task_actions'] = $provider->get_task_actions( $response->data );
 		}
 
diff --git a/classes/suggested-tasks/class-tasks-interface.php b/classes/suggested-tasks/class-tasks-interface.php
@@ -104,6 +104,13 @@ public function is_repetitive();
 	 */
 	public function get_task_actions( $data = [] );
 
+	/**
+	 * Get the popover ID.
+	 *
+	 * @return string
+	 */
+	public function get_popover_id();
+
 	/**
 	 * Add task actions specific to this task.
 	 *
diff --git a/classes/suggested-tasks/providers/class-blog-description.php b/classes/suggested-tasks/providers/class-blog-description.php
@@ -134,7 +134,7 @@ class="regular-text"
 	public function add_task_actions( $data = [], $actions = [] ) {
 		$actions[] = [
 			'priority' => 10,
-			'html'     => '<a href="#" class="prpl-tooltip-action-text" role="button" onclick="document.getElementById(\'' . \esc_attr( $data['meta']['prpl_popover_id'] ) . '\')?.showPopover()">' . \esc_html__( 'Set tagline', 'progress-planner' ) . '</a>',
+			'html'     => '<a href="#" class="prpl-tooltip-action-text" role="button" onclick="document.getElementById(\'prpl-popover-' . \esc_attr( static::POPOVER_ID ) . '\')?.showPopover()">' . \esc_html__( 'Set tagline', 'progress-planner' ) . '</a>',
 		];
 
 		return $actions;
diff --git a/classes/suggested-tasks/providers/class-disable-comment-pagination.php b/classes/suggested-tasks/providers/class-disable-comment-pagination.php
@@ -131,7 +131,7 @@ public function print_popover_form_contents() {
 	public function add_task_actions( $data = [], $actions = [] ) {
 		$actions[] = [
 			'priority' => 10,
-			'html'     => '<a href="#" class="prpl-tooltip-action-text" role="button" onclick="document.getElementById(\'' . \esc_attr( $data['meta']['prpl_popover_id'] ) . '\')?.showPopover()">' . \esc_html__( 'Disable pagination', 'progress-planner' ) . '</a>',
+			'html'     => '<a href="#" class="prpl-tooltip-action-text" role="button" onclick="document.getElementById(\'prpl-popover-' . \esc_attr( static::POPOVER_ID ) . '\')?.showPopover()">' . \esc_html__( 'Disable pagination', 'progress-planner' ) . '</a>',
 		];
 
 		return $actions;
diff --git a/classes/suggested-tasks/providers/class-disable-comments.php b/classes/suggested-tasks/providers/class-disable-comments.php
@@ -162,7 +162,7 @@ public function print_popover_form_contents() {
 	public function add_task_actions( $data = [], $actions = [] ) {
 		$actions[] = [
 			'priority' => 10,
-			'html'     => '<a href="#" class="prpl-tooltip-action-text" role="button" onclick="document.getElementById(\'' . \esc_attr( $data['meta']['prpl_popover_id'] ) . '\')?.showPopover()">' . \esc_html__( 'Disable comments', 'progress-planner' ) . '</a>',
+			'html'     => '<a href="#" class="prpl-tooltip-action-text" role="button" onclick="document.getElementById(\'prpl-popover-' . \esc_attr( static::POPOVER_ID ) . '\')?.showPopover()">' . \esc_html__( 'Disable comments', 'progress-planner' ) . '</a>',
 		];
 
 		return $actions;
diff --git a/classes/suggested-tasks/providers/class-email-sending.php b/classes/suggested-tasks/providers/class-email-sending.php
@@ -321,7 +321,7 @@ public function print_popover_form_contents() {
 	public function add_task_actions( $data = [], $actions = [] ) {
 		$actions[] = [
 			'priority' => 10,
-			'html'     => '<a href="#" class="prpl-tooltip-action-text" role="button" onclick="document.getElementById(\'' . \esc_attr( $data['meta']['prpl_popover_id'] ) . '\')?.showPopover()">' . \esc_html__( 'Test email sending', 'progress-planner' ) . '</a>',
+			'html'     => '<a href="#" class="prpl-tooltip-action-text" role="button" onclick="document.getElementById(\'prpl-popover-' . \esc_attr( static::POPOVER_ID ) . '\')?.showPopover()">' . \esc_html__( 'Test email sending', 'progress-planner' ) . '</a>',
 		];
 
 		return $actions;
diff --git a/classes/suggested-tasks/providers/class-hello-world.php b/classes/suggested-tasks/providers/class-hello-world.php
@@ -164,7 +164,7 @@ protected function get_enqueue_data() {
 	public function add_task_actions( $data = [], $actions = [] ) {
 		$actions[] = [
 			'priority' => 10,
-			'html'     => '<a href="#" class="prpl-tooltip-action-text" role="button" onclick="document.getElementById(\'' . \esc_attr( $data['meta']['prpl_popover_id'] ) . '\')?.showPopover()">' . \esc_html__( 'Delete', 'progress-planner' ) . '</a>',
+			'html'     => '<a href="#" class="prpl-tooltip-action-text" role="button" onclick="document.getElementById(\'prpl-popover-' . \esc_attr( static::POPOVER_ID ) . '\')?.showPopover()">' . \esc_html__( 'Delete', 'progress-planner' ) . '</a>',
 		];
 
 		return $actions;
diff --git a/classes/suggested-tasks/providers/class-sample-page.php b/classes/suggested-tasks/providers/class-sample-page.php
@@ -163,7 +163,7 @@ protected function get_enqueue_data() {
 	public function add_task_actions( $data = [], $actions = [] ) {
 		$actions[] = [
 			'priority' => 10,
-			'html'     => '<a href="#" class="prpl-tooltip-action-text" role="button" onclick="document.getElementById(\'' . \esc_attr( $data['meta']['prpl_popover_id'] ) . '\')?.showPopover()">' . \esc_html__( 'Delete', 'progress-planner' ) . '</a>',
+			'html'     => '<a href="#" class="prpl-tooltip-action-text" role="button" onclick="document.getElementById(\'prpl-popover-' . \esc_attr( static::POPOVER_ID ) . '\')?.showPopover()">' . \esc_html__( 'Delete', 'progress-planner' ) . '</a>',
 		];
 
 		return $actions;
diff --git a/classes/suggested-tasks/providers/class-select-locale.php b/classes/suggested-tasks/providers/class-select-locale.php
@@ -299,7 +299,7 @@ public function handle_interactive_task_specific_submit() {
 	public function add_task_actions( $data = [], $actions = [] ) {
 		$actions[] = [
 			'priority' => 10,
-			'html'     => '<a href="#" class="prpl-tooltip-action-text" role="button" onclick="document.getElementById(\'' . \esc_attr( $data['meta']['prpl_popover_id'] ) . '\')?.showPopover()">' . \esc_html__( 'Select locale', 'progress-planner' ) . '</a>',
+			'html'     => '<a href="#" class="prpl-tooltip-action-text" role="button" onclick="document.getElementById(\'prpl-popover-' . \esc_attr( static::POPOVER_ID ) . '\')?.showPopover()">' . \esc_html__( 'Select locale', 'progress-planner' ) . '</a>',
 		];
 
 		return $actions;
diff --git a/classes/suggested-tasks/providers/class-select-timezone.php b/classes/suggested-tasks/providers/class-select-timezone.php
@@ -221,7 +221,7 @@ public function handle_interactive_task_specific_submit() {
 	public function add_task_actions( $data = [], $actions = [] ) {
 		$actions[] = [
 			'priority' => 10,
-			'html'     => '<a href="#" class="prpl-tooltip-action-text" role="button" onclick="document.getElementById(\'' . \esc_attr( $data['meta']['prpl_popover_id'] ) . '\')?.showPopover()">' . \esc_html__( 'Select timezone', 'progress-planner' ) . '</a>',
+			'html'     => '<a href="#" class="prpl-tooltip-action-text" role="button" onclick="document.getElementById(\'prpl-popover-' . \esc_attr( static::POPOVER_ID ) . '\')?.showPopover()">' . \esc_html__( 'Select timezone', 'progress-planner' ) . '</a>',
 		];
 
 		return $actions;
diff --git a/classes/suggested-tasks/providers/class-tasks.php b/classes/suggested-tasks/providers/class-tasks.php
@@ -66,6 +66,13 @@ abstract class Tasks implements Tasks_Interface {
 	 */
 	protected const EXTERNAL_LINK_URL = '';
 
+	/**
+	 * The popover ID.
+	 *
+	 * @var string
+	 */
+	protected const POPOVER_ID = '';
+
 	/**
 	 * Whether the task is repetitive.
 	 *
@@ -180,6 +187,15 @@ public function get_parent() {
 		return $this->parent;
 	}
 
+	/**
+	 * Get the popover ID.
+	 *
+	 * @return string
+	 */
+	public function get_popover_id() {
+		return static::POPOVER_ID;
+	}
+
 	/**
 	 * Get the task priority.
 	 *
diff --git a/classes/ui/class-popover.php b/classes/ui/class-popover.php
@@ -56,11 +56,6 @@ public function render_button( $icon, $content ) {
 	 * @return void
 	 */
 	public function render() {
-		\progress_planner()->the_view(
-			'popovers/popover.php',
-			[
-				'prpl_popover_id' => $this->id,
-			]
-		);
+		\progress_planner()->the_view( 'popovers/popover.php', [ 'prpl_popover_id' => $this->id ] );
 	}
 }
diff --git a/classes/update/class-update-170.php b/classes/update/class-update-170.php
@@ -54,9 +54,7 @@ private function make_tasks_interactive() {
 			// Update the task.
 			\progress_planner()->get_suggested_tasks_db()->update_recommendation(
 				$task[0]->ID,
-				[
-					'prpl_popover_id' => 'prpl-popover-' . $task_id,
-				]
+				[ 'prpl_popover_id' => 'prpl-popover-' . $task_id ]
 			);
 
 		}
