thinkrank / includes / api / class-global-robot-meta-endpoint.php

class-global-robot-meta-endpoint.php in ThinkRank AI SEO – AI SEO Plugin for WordPress: Schema, XML Sitemaps, Meta Tags, Search Console & Local SEO 2.1.1, at includes/api/class-global-robot-meta-endpoint.php

194 lines 5.3 KB

Raw Download Zip

1	<?php
2	/**
3	* Global Robot Meta API Endpoints Class
4	*
5	* REST API endpoints for global robots meta tags settings.
6	*
7	* @package ThinkRank
8	* @subpackage API
9	* @since 1.0.0
10	*/
11
12	declare(strict_types=1);
13
14	namespace ThinkRank\API;
15
16	use WP_REST_Controller;
17	use WP_REST_Request;
18	use WP_REST_Response;
19	use WP_Error;
20
21	// Prevent direct access
22	if (!defined('ABSPATH')) {
23	exit;
24	}
25
26	/**
27	* Global Robot Meta API Endpoints Class
28	*
29	* @since 1.0.0
30	*/
31	class Global_Robot_Meta_Endpoint extends WP_REST_Controller {
32
33	/**
34	* API namespace
35	*
36	* @since 1.0.0
37	* @var string
38	*/
39	protected $namespace = 'thinkrank/v1';
40
41	/**
42	* API resource base
43	*
44	* @since 1.0.0
45	* @var string
46	*/
47	protected $rest_base = 'global-robot-meta';
48
49	/**
50	* Option name
51	*/
52	private const OPTION_NAME = 'thinkrank_global_robot_meta_settings';
53
54	/**
55	* Register API routes
56	*
57	* @since 1.0.0
58	*/
59	public function register_routes(): void {
60	register_rest_route(
61	$this->namespace,
62	'/' . $this->rest_base . '/settings',
63	[
64	[
65	'methods' => 'GET',
66	'callback' => [$this, 'get_settings'],
67	'permission_callback' => [$this, 'check_read_permissions']
68	],
69	[
70	'methods' => 'POST',
71	'callback' => [$this, 'update_settings'],
72	'permission_callback' => [$this, 'check_manage_permissions'],
73	'args' => $this->get_settings_args()
74	]
75	]
76	);
77	}
78
79	/**
80	* Get settings
81	*
82	* @param WP_REST_Request $request Request object
83	* @return WP_REST_Response Response object
84	*/
85	public function get_settings(WP_REST_Request $request): WP_REST_Response {
86	$settings = get_option(self::OPTION_NAME, $this->get_default_settings());
87
88	return new WP_REST_Response([
89	'success' => true,
90	'settings' => $settings,
91	'message' => 'Settings retrieved successfully'
92	], 200);
93	}
94
95	/**
96	* Update settings
97	*
98	* @param WP_REST_Request $request Request object
99	* @return WP_REST_Response\|WP_Error Response object or error
100	*/
101	public function update_settings(WP_REST_Request $request) {
102	$settings = $request->get_param('settings');
103
104	if (empty($settings) \|\| !is_array($settings)) {
105	return new WP_Error(
106	'invalid_settings',
107	'Settings must be provided as an array',
108	['status' => 400]
109	);
110	}
111
112	// Merge the 6 robots booleans into the existing option rather than
113	// replacing it, so sibling keys written by other paths (e.g. the SEO
114	// importer's noindex_date_archives / noindex_author_archives, consumed
115	// by the frontend) survive a save. Mirrors the MCP ability's merge.
116	$existing = get_option(self::OPTION_NAME, []);
117	if (!is_array($existing)) {
118	$existing = [];
119	}
120	$sanitized_settings = array_merge($existing, [
121	'index' => isset($settings['index']) ? (bool) $settings['index'] : true,
122	'noindex' => isset($settings['noindex']) ? (bool) $settings['noindex'] : false,
123	'nofollow' => isset($settings['nofollow']) ? (bool) $settings['nofollow'] : false,
124	'noarchive' => isset($settings['noarchive']) ? (bool) $settings['noarchive'] : false,
125	'noimageindex' => isset($settings['noimageindex']) ? (bool) $settings['noimageindex'] : false,
126	'nosnippet' => isset($settings['nosnippet']) ? (bool) $settings['nosnippet'] : false,
127	]);
128
129	update_option(self::OPTION_NAME, $sanitized_settings);
130
131	return new WP_REST_Response([
132	'success' => true,
133	'settings' => $sanitized_settings,
134	'message' => 'Settings saved successfully'
135	], 200);
136	}
137
138	/**
139	* Get default settings
140	*
141	* @return array
142	*/
143	private function get_default_settings(): array {
144	return [
145	'index' => true,
146	'noindex' => false,
147	'nofollow' => false,
148	'noarchive' => false,
149	'noimageindex' => false,
150	'nosnippet' => false,
151	];
152	}
153
154	/**
155	* Get settings args for validation
156	*
157	* @return array
158	*/
159	private function get_settings_args(): array {
160	return [
161	'settings' => [
162	'required' => true,
163	'type' => 'object',
164	'properties' => [
165	'index' => ['type' => 'boolean'],
166	'noindex' => ['type' => 'boolean'],
167	'nofollow' => ['type' => 'boolean'],
168	'noarchive' => ['type' => 'boolean'],
169	'noimageindex' => ['type' => 'boolean'],
170	'nosnippet' => ['type' => 'boolean'],
171	]
172	]
173	];
174	}
175
176	/**
177	* Check read permissions
178	*
179	* @return bool
180	*/
181	public function check_read_permissions(): bool {
182	return current_user_can('edit_posts');
183	}
184
185	/**
186	* Check manage permissions
187	*
188	* @return bool
189	*/
190	public function check_manage_permissions(): bool {
191	return \ThinkRank\Core\Capability_Manager::current_user_can('thinkrank_crawling');
192	}
193	}
194