3b03e4aa7834b01141da619d04c1b58d852524a2

Committed 17 Dec 2025 10:34AM UTC coverage: 53.029% (-0.01%) from 53.04%

Build # 3b03e4aa7834b01141da619d04c1b58d852524a2

Build Type

Pull #22815

github

Committed by

web-flow

Commit Message

Merge b7c174221 into 5025ae743

Pull Request Pull Request #22815: Add tracking for the task list.

Run Details

8708 of 16082 branches covered (54.15%)

Branch coverage included in aggregate %.

34 of 80 new or added lines in 11 files covered. (42.5%)

2 existing lines in 2 files now uncovered.

32454 of 61539 relevant lines covered (52.74%)

46855.41 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/src/task-list/user-interface/tasks/get-tasks-route.php

<?php
// phpcs:disable Yoast.NamingConventions.NamespaceName.TooLong -- Needed in the folder structure.
namespace Yoast\WP\SEO\Task_List\User_Interface\Tasks;

use Exception;
use WP_REST_Response;
use Yoast\WP\SEO\Conditionals\Task_List_Enabled_Conditional;
use Yoast\WP\SEO\Helpers\Capability_Helper;
use Yoast\WP\SEO\Main;
use Yoast\WP\SEO\Routes\Route_Interface;
use Yoast\WP\SEO\Task_List\Application\Tasks_Repository;
use Yoast\WP\SEO\Tracking\Application\Action_Tracker;

/**
 * Get tasks route.
 */
final class Get_Tasks_Route implements Route_Interface {

        /**
         * The namespace of the route.
         *
         * @var string
         */
        public const ROUTE_NAMESPACE = Main::API_V1_NAMESPACE;

        /**
         * The prefix of the route.
         *
         * @var string
         */
        public const ROUTE_NAME = '/get_tasks';

        /**
         * The task repository.
         *
         * @var Tasks_Repository
         */
        private $tasks_repository;

        /**
         * Holds the capability helper instance.
         *
         * @var Capability_Helper
         */
        private $capability_helper;

        /**
         * Holds the action tracker instance.
         *
         * @var Action_Tracker
         */
        private $action_tracker;

        /**
         * Returns the needed conditionals.
         *
         * @return array<string> The conditionals that must be met to load this.
         */
        public static function get_conditionals(): array {
                return [
                        Task_List_Enabled_Conditional::class,
                ];
        }

        /**
         * The constructor.
         *
         * @param Tasks_Repository  $tasks_repository  The repository for all tasks.
         * @param Capability_Helper $capability_helper The capability helper.
         * @param Action_Tracker    $action_tracker    The action tracker.
         */
        public function __construct(
                Tasks_Repository $tasks_repository,
                Capability_Helper $capability_helper,
                Action_Tracker $action_tracker
        ) {
                $this->tasks_repository  = $tasks_repository;
                $this->capability_helper = $capability_helper;
                $this->action_tracker    = $action_tracker;
        }

        /**
         * Registers routes for scores.
         *
         * @return void
         */
        public function register_routes() {
                \register_rest_route(
                        self::ROUTE_NAMESPACE,
                        self::ROUTE_NAME,
                        [
                                [
                                        'methods'             => 'GET',
                                        'callback'            => [ $this, 'get_tasks' ],
                                        'permission_callback' => [ $this, 'permission_manage_options' ],
                                        'args'                => [
                                                'options' => [
                                                        'type'       => 'object',
                                                        'required'   => false,
                                                        'properties' => [
                                                                'filter' => [
                                                                        'type'              => 'string',
                                                                        'required'          => false,
                                                                        'sanitize_callback' => 'sanitize_text_field',
                                                                ],
                                                                'limit' => [
                                                                        'type'              => 'int',
                                                                        'required'          => false,
                                                                        'sanitize_callback' => 'absint',
                                                                ],
                                                        ],
                                                ],
                                        ],
                                ],
                        ]
                );
        }

        /**
         * Gets tasks with their information.
         *
         * @return WP_REST_Response The success or failure response.
         */
        public function get_tasks(): WP_REST_Response {
                try {
                        $this->action_tracker->track_version_for_performed_action( 'task_list_first_opened_on' );

                        $tasks_data = $this->tasks_repository->get_tasks_data();
                } catch ( Exception $exception ) {
                        return new WP_REST_Response(
                                [
                                        'success' => false,
                                        'error'   => $exception->getMessage(),
                                ],
                                $exception->getCode()
                        );
                }

                return new WP_REST_Response(
                        [
                                'success' => true,
                                'tasks'   => $tasks_data,
                        ],
                        200
                );
        }

        /**
         * Permission callback.
         *
         * @return bool True when user has the 'wpseo_manage_options' capability.
         */
        public function permission_manage_options() {
                return $this->capability_helper->current_user_can( 'wpseo_manage_options' );
        }
}

1	<?php
2	// phpcs:disable Yoast.NamingConventions.NamespaceName.TooLong -- Needed in the folder structure.
3	namespace Yoast\WP\SEO\Task_List\User_Interface\Tasks;
4
5	use Exception;
6	use WP_REST_Response;
7	use Yoast\WP\SEO\Conditionals\Task_List_Enabled_Conditional;
8	use Yoast\WP\SEO\Helpers\Capability_Helper;
9	use Yoast\WP\SEO\Main;
10	use Yoast\WP\SEO\Routes\Route_Interface;
11	use Yoast\WP\SEO\Task_List\Application\Tasks_Repository;
12	use Yoast\WP\SEO\Tracking\Application\Action_Tracker;
13
14	/**
15	* Get tasks route.
16	*/
17	final class Get_Tasks_Route implements Route_Interface {
18
19	/**
20	* The namespace of the route.
21	*
22	* @var string
23	*/
24	public const ROUTE_NAMESPACE = Main::API_V1_NAMESPACE;
25
26	/**
27	* The prefix of the route.
28	*
29	* @var string
30	*/
31	public const ROUTE_NAME = '/get_tasks';
32
33	/**
34	* The task repository.
35	*
36	* @var Tasks_Repository
37	*/
38	private $tasks_repository;
39
40	/**
41	* Holds the capability helper instance.
42	*
43	* @var Capability_Helper
44	*/
45	private $capability_helper;
46
47	/**
48	* Holds the action tracker instance.
49	*
50	* @var Action_Tracker
51	*/
52	private $action_tracker;
53
54	/**
55	* Returns the needed conditionals.
56	*
57	* @return array<string> The conditionals that must be met to load this.
58	*/
59	public static function get_conditionals(): array {	×
60	return [	×
61	Task_List_Enabled_Conditional::class,	×
62	];	×
63	}
64
65	/**
66	* The constructor.
67	*
68	* @param Tasks_Repository $tasks_repository The repository for all tasks.
69	* @param Capability_Helper $capability_helper The capability helper.
70	* @param Action_Tracker $action_tracker The action tracker.
71	*/
72	public function __construct(	×
73	Tasks_Repository $tasks_repository,
74	Capability_Helper $capability_helper,
75	Action_Tracker $action_tracker
76	) {
77	$this->tasks_repository = $tasks_repository;	×
78	$this->capability_helper = $capability_helper;	×
NEW 79	$this->action_tracker = $action_tracker;	×
80	}
81
82	/**
83	* Registers routes for scores.
84	*
85	* @return void
86	*/
87	public function register_routes() {	×
88	\register_rest_route(	×
89	self::ROUTE_NAMESPACE,	×
90	self::ROUTE_NAME,	×
91	[	×
92	[	×
93	'methods' => 'GET',	×
94	'callback' => [ $this, 'get_tasks' ],	×
95	'permission_callback' => [ $this, 'permission_manage_options' ],	×
96	'args' => [	×
97	'options' => [	×
98	'type' => 'object',	×
99	'required' => false,	×
100	'properties' => [	×
101	'filter' => [	×
102	'type' => 'string',	×
103	'required' => false,	×
104	'sanitize_callback' => 'sanitize_text_field',	×
105	],	×
106	'limit' => [	×
107	'type' => 'int',	×
108	'required' => false,	×
109	'sanitize_callback' => 'absint',	×
110	],	×
111	],	×
112	],	×
113	],	×
114	],	×
115	]	×
116	);	×
117	}
118
119	/**
120	* Gets tasks with their information.
121	*
122	* @return WP_REST_Response The success or failure response.
123	*/
124	public function get_tasks(): WP_REST_Response {	×
125	try {
NEW 126	$this->action_tracker->track_version_for_performed_action( 'task_list_first_opened_on' );	×
127
128	$tasks_data = $this->tasks_repository->get_tasks_data();	×
129	} catch ( Exception $exception ) {	×
130	return new WP_REST_Response(	×
131	[	×
132	'success' => false,	×
133	'error' => $exception->getMessage(),	×
134	],	×
135	$exception->getCode()	×
136	);	×
137	}
138
139	return new WP_REST_Response(	×
140	[	×
141	'success' => true,	×
142	'tasks' => $tasks_data,	×
143	],	×
144	200	×
145	);	×
146	}
147
148	/**
149	* Permission callback.
150	*
151	* @return bool True when user has the 'wpseo_manage_options' capability.
152	*/
153	public function permission_manage_options() {	×
154	return $this->capability_helper->current_user_can( 'wpseo_manage_options' );	×
155	}
156	}

Yoast / wordpress-seo / 3b03e4aa7834b01141da619d04c1b58d852524a2

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous