PluginProbe
User Access Manager / 2.2.23
User Access Manager v2.2.23
2.3.20 2.3.19 2.3.18 2.3.17 2.3.16 2.3.15 2.3.14 2.3.13 trunk 0.6 0.6.1 0.6.2 0.7 0.7 Beta 0.7.0.1 0.8 0.8.0.1 0.8.0.2 0.9 0.9.1 0.9.1.1 0.9.1.2 0.9.1.3 0.9.1.4 1.0 All 136 releases
← All changes | src/Wrapper/Wordpress.php +415 -302 2.3.152.2.23 View file →
@@ -1,11 +1,23 @@
1 1 <?php
2 +/**
3 + * Wordpress.php
4 + *
5 + * The Wordpress class file.
6 + *
7 + * PHP versions 5
8 + *
9 + * @author Alexander Schneider <[email protected]>
10 + * @copyright 2008-2017 Alexander Schneider
11 + * @license http://www.gnu.org/licenses/gpl-2.0.html GNU General Public License, version 2
12 + * @version SVN: $id$
13 + * @link http://wordpress.org/extend/plugins/user-access-manager/
14 + */
2 15
3 16 declare(strict_types=1);
4 17
5 18 namespace UserAccessManager\Wrapper;
6 19
7 -use JetBrains\PhpStorm\NoReturn;
8 20 use WP_Error;
9 21 use WP_Hook;
10 22 use WP_Post;
11 23 use WP_Post_Type;
@@ -19,9 +31,8 @@
19 31 use function add_filter;
20 32 use function add_menu_page;
21 33 use function add_meta_box;
22 34 use function add_option;
23 -use function add_query_arg;
24 35 use function add_shortcode;
25 36 use function add_submenu_page;
26 37 use function attachment_url_to_postid;
27 38 use function current_time;
@@ -88,15 +99,19 @@
88 99 use function wp_registration_url;
89 100 use function wp_upload_dir;
90 101 use function wp_verify_nonce;
91 102
103 +/**
104 + * Class Wordpress
105 + *
106 + * @package UserAccessManager\Wrapper
107 + */
92 108 class Wordpress
93 109 {
94 - public const REST_READING_METHODS = ['GET', 'HEAD'];
95 -
96 - private bool $restRequestDispatched = false;
97 - private bool $editingRestRequestDetected = false;
98 -
110 + /**
111 + * Returns the database.
112 + * @return wpdb
113 + */
99 114 public function getDatabase(): wpdb
100 115 {
101 116 global $wpdb;
102 117 return $wpdb;
@@ -101,8 +116,12 @@
101 116 global $wpdb;
102 117 return $wpdb;
103 118 }
104 119
120 + /**
121 + * Returns true if web server is nginx.
122 + * @return bool
123 + */
105 124 public function isNginx(): bool
106 125 {
107 126 global $is_nginx;
108 127 return $is_nginx;
@@ -108,26 +127,12 @@
108 127 return $is_nginx;
109 128 }
110 129
111 130 /**
112 - * @see wp_using_ext_object_cache
131 + * @param string $postType
132 + * @return bool
133 + * @see \is_post_type_hierarchical()
113 134 */
114 - public function isUsingExtObjectCache(): bool
115 - {
116 - return function_exists('wp_using_ext_object_cache') && wp_using_ext_object_cache() === true;
117 - }
118 -
119 - /**
120 - * @see apache_get_modules
121 - */
122 - public function isApacheModuleLoaded(string $module): bool
123 - {
124 - return function_exists('apache_get_modules') && in_array($module, apache_get_modules(), true);
125 - }
126 -
127 - /**
128 - * @see is_post_type_hierarchical
129 - */
130 135 public function isPostTypeHierarchical(string $postType): bool
131 136 {
132 137 return is_post_type_hierarchical($postType);
133 138 }
@@ -132,9 +137,11 @@
132 137 return is_post_type_hierarchical($postType);
133 138 }
134 139
135 140 /**
136 - * @see is_taxonomy_hierarchical
141 + * @param string $taxonomy
142 + * @return bool
143 + * @see \is_taxonomy_hierarchical()
137 144 */
138 145 public function isTaxonomyHierarchical(string $taxonomy): bool
139 146 {
140 147 return is_taxonomy_hierarchical($taxonomy);
@@ -140,79 +147,94 @@
140 147 return is_taxonomy_hierarchical($taxonomy);
141 148 }
142 149
143 150 /**
144 - * @see get_userdata
151 + * @param int|string $id
152 + * @return false|WP_User
153 + * @see \get_userdata()
145 154 */
146 - public function getUserData(int|string|null $id): WP_User|bool
155 + public function getUserData($id)
147 156 {
148 157 return get_userdata($id);
149 158 }
150 159
151 160 /**
152 - * @see get_post_types
161 + * @param string|array $arguments
162 + * @param string $output
163 + * @param string $operator
164 + * @return array
165 + * @see \get_post_types()
153 166 */
154 - public function getPostTypes(
155 - array|string|int $arguments = [],
156 - string $output = 'names',
157 - string $operator = 'and'
158 - ): array {
167 + public function getPostTypes($arguments = [], $output = 'names', $operator = 'and'): array
168 + {
159 169 return get_post_types($arguments, $output, $operator);
160 170 }
161 171
162 172 /**
163 - * @return string[]|WP_Taxonomy[]
164 - * @see get_taxonomies
173 + * @param array $arguments
174 + * @param string $output
175 + * @param string $operator
176 + * @return array
177 + * @see \get_taxonomies()
165 178 */
166 - public function getTaxonomies(array $arguments = [], string $output = 'names', string $operator = 'and'): array
179 + public function getTaxonomies(array $arguments = [], $output = 'names', $operator = 'and'): array
167 180 {
168 181 return get_taxonomies($arguments, $output, $operator);
169 182 }
170 183
171 184 /**
172 - * @see get_taxonomy
185 + * @param string $taxonomy
186 + * @return false|WP_Taxonomy
187 + * @see \get_taxonomy()
173 188 */
174 - public function getTaxonomy(string $taxonomy): WP_Taxonomy|bool
189 + public function getTaxonomy(string $taxonomy)
175 190 {
176 191 return get_taxonomy($taxonomy);
177 192 }
178 193
179 194 /**
180 - * @see get_post
195 + * @param int|string $id The post id.
196 + * @param string $output
197 + * @param string $filter
198 + * @return WP_Post|array|null
199 + * @see \get_post()
181 200 */
182 - public function getPost(
183 - int|string|null $id,
184 - string $output = OBJECT,
185 - string $filter = 'raw'
186 - ): WP_Post|array|bool|null {
201 + public function getPost($id, $output = OBJECT, $filter = 'raw')
202 + {
187 203 return get_post($id, $output, $filter);
188 204 }
189 205
190 206 /**
191 - * @see get_post_type_object
207 + * @param int|string $postType
208 + * @return null|WP_Post_Type
209 + * @see \get_post_type_object()
192 210 */
193 - public function getPostTypeObject(int|string $postType): ?WP_Post_Type
211 + public function getPostTypeObject($postType): ?WP_Post_Type
194 212 {
195 213 return get_post_type_object($postType);
196 214 }
197 215
198 216 /**
199 - * @see get_term
217 + * @param int|string $id
218 + * @param string $taxonomy
219 + * @param string $output
220 + * @param string $filter
221 + * @return array|null|WP_Error|WP_Term
222 + * @see \get_term()
200 223 */
201 - public function getTerm(
202 - int|string $id,
203 - string $taxonomy = '',
204 - string $output = OBJECT,
205 - string $filter = 'raw'
206 - ): WP_Term|WP_Error|array|bool|null {
224 + public function getTerm($id, string $taxonomy = '', string $output = OBJECT, string $filter = 'raw')
225 + {
207 226 return get_term($id, $taxonomy, $output, $filter);
208 227 }
209 228
210 229
211 230 /**
212 - * @see dbDelta
231 + * @param array|string $queries
232 + * @param bool $execute
233 + * @return array
234 + * @see \dbDelta()
213 235 */
214 - public function dbDelta(array|string $queries = '', bool $execute = true): array
236 + public function dbDelta($queries = '', $execute = true): array
215 237 {
216 238 if (function_exists('\dbDelta') === false) {
217 239 require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
218 240 }
@@ -220,11 +242,13 @@
220 242 return dbDelta($queries, $execute);
221 243 }
222 244
223 245 /**
224 - * @see switch_to_blog
246 + * @param integer $blogId
247 + * @return int|string
248 + * @see \switch_to_blog()
225 249 */
226 - public function switchToBlog(int|string|null $blogId): bool
250 + public function switchToBlog($blogId)
227 251 {
228 252 if (function_exists('\switch_to_blog') === true) {
229 253 return switch_to_blog($blogId);
230 254 }
@@ -232,8 +256,9 @@
232 256 return true;
233 257 }
234 258
235 259 /**
260 + * @return bool
236 261 * @see \restore_current_blog()
237 262 */
238 263 public function restoreCurrentBlog(): bool
239 264 {
@@ -244,9 +269,10 @@
244 269 return true;
245 270 }
246 271
247 272 /**
248 - * @see is_multisite
273 + * @return bool
274 + * @see \is_multisite()
249 275 */
250 276 public function isMultiSite(): bool
251 277 {
252 278 return is_multisite();
@@ -252,85 +278,95 @@
252 278 return is_multisite();
253 279 }
254 280
255 281 /**
256 - * @see do_action
282 + * @param string $tag
283 + * @param mixed $arguments
284 + * @see \do_action()
257 285 */
258 - public function doAction(string $tag, mixed $arguments = ''): void
286 + public function doAction(string $tag, $arguments = '')
259 287 {
260 288 do_action($tag, $arguments);
261 289 }
262 290
263 291 /**
264 - * @see add_action
292 + * @param string $tag
293 + * @param callable $functionToAdd
294 + * @param int $priority
295 + * @param int $acceptedArguments
296 + * @return true
297 + * @see \add_action()
265 298 */
266 - public function addAction(
267 - string $tag,
268 - callable $functionToAdd,
269 - int $priority = 10,
270 - int $acceptedArguments = 1
271 - ): bool {
299 + public function addAction(string $tag, callable $functionToAdd, $priority = 10, $acceptedArguments = 1)
300 + {
272 301 return add_action($tag, $functionToAdd, $priority, $acceptedArguments);
273 302 }
274 303
275 304 /**
276 - * @see remove_action
305 + * @param string $hookName
306 + * @param callable $callback
307 + * @param $priority
308 + * @return bool
309 + * @see \remove_action()
277 310 */
278 - public function removeAction(string $hookName, callable $callback, int $priority = 10): bool
311 + public function removeAction(string $hookName, callable $callback, $priority = 10)
279 312 {
280 313 return remove_action($hookName, $callback, $priority);
281 314 }
282 315
283 316 /**
284 - * @see has_filter
317 + * @param string $tag
318 + * @param bool|callable $functionToCheck
319 + * @return bool|false|int
320 + * @see \has_filter()
285 321 */
286 - public function hasFilter(string $tag, callable|bool $functionToCheck = false): bool|int
322 + public function hasFilter(string $tag, $functionToCheck = false)
287 323 {
288 324 return has_filter($tag, $functionToCheck);
289 325 }
290 326
291 327 /**
292 - * @see add_filter
328 + * @param string $tag
329 + * @param callable $functionToAdd
330 + * @param int $priority
331 + * @param int $acceptedArguments
332 + * @return true
333 + * @see \add_filter()
293 334 */
294 - public function addFilter(
295 - string $tag,
296 - callable $functionToAdd,
297 - int $priority = 10,
298 - int $acceptedArguments = 1
299 - ): bool {
335 + public function addFilter(string $tag, callable $functionToAdd, $priority = 10, $acceptedArguments = 1)
336 + {
300 337 return add_filter($tag, $functionToAdd, $priority, $acceptedArguments);
301 338 }
302 339
303 340 /**
304 - * @see WP_Error
341 + * @param string $tag
342 + * @param callable $functionToRemove
343 + * @param int $priority
344 + * @return bool
345 + * @see \remove_filter()
305 346 */
306 - public function getWpError(string|int $code = '', string $message = '', mixed $data = ''): WP_Error
347 + public function removeFilter(string $tag, callable $functionToRemove, $priority = 10): bool
307 348 {
308 - return new WP_Error($code, $message, $data);
349 + return remove_filter($tag, $functionToRemove, $priority);
309 350 }
310 351
311 352 /**
312 - * @see remove_filter
353 + * @param string $option
354 + * @param mixed $value
355 + * @param string $deprecated
356 + * @param string|bool $autoload
357 + * @return bool
358 + * @see \add_option()
313 359 */
314 - public function removeFilter(string $tag, callable $functionToRemove, int $priority = 10): bool
360 + public function addOption(string $option, $value = '', $deprecated = '', $autoload = 'yes'): bool
315 361 {
316 - return remove_filter($tag, $functionToRemove, $priority);
317 - }
318 -
319 - /**
320 - * @see add_option
321 - */
322 - public function addOption(
323 - string $option,
324 - mixed $value = '',
325 - string $deprecated = '',
326 - bool|string $autoload = 'yes'
327 - ): bool {
328 362 return add_option($option, $value, $deprecated, $autoload);
329 363 }
330 364
331 365 /**
332 - * @see delete_option
366 + * @param string $option
367 + * @return bool
368 + * @see \delete_option()
333 369 */
334 370 public function deleteOption(string $option): bool
335 371 {
336 372 return delete_option($option);
@@ -336,57 +372,43 @@
336 372 return delete_option($option);
337 373 }
338 374
339 375 /**
340 - * @see update_option
376 + * @param string $option
377 + * @param mixed $value
378 + * @param string|bool $autoload
379 + * @return bool
380 + * @see \update_option()
341 381 */
342 - public function updateOption(string $option, mixed $value = '', bool|string $autoload = 'yes'): bool
382 + public function updateOption(string $option, $value = '', $autoload = 'yes'): bool
343 383 {
344 384 return update_option($option, $value, $autoload);
345 385 }
346 386
347 387 /**
348 - * @see get_option
388 + * @param string $option
389 + * @param mixed $default
390 + * @return mixed
391 + * @see \get_option()
349 392 */
350 - public function getOption(string $option, mixed $default = false)
393 + public function getOption(string $option, $default = false)
351 394 {
352 395 return get_option($option, $default);
353 396 }
354 397
355 398 /**
356 - * @see wp_cache_set
399 + * @param int|bool $userId
400 + * @return bool
401 + * @see \is_super_admin()
357 402 */
358 - public function wpCacheSet(string $key, mixed $data, string $group = '', int $expire = 0): bool
403 + public function isSuperAdmin($userId = false): bool
359 404 {
360 - return wp_cache_set($key, $data, $group, $expire);
361 - }
362 -
363 - /**
364 - * @see wp_cache_get
365 - */
366 - public function wpCacheGet(string $key, string $group = ''): mixed
367 - {
368 - return wp_cache_get($key, $group);
369 - }
370 -
371 - /**
372 - * @see wp_cache_delete
373 - */
374 - public function wpCacheDelete(string $key, string $group = ''): bool
375 - {
376 - return wp_cache_delete($key, $group);
377 - }
378 -
379 - /**
380 - * @see is_super_admin
381 - */
382 - public function isSuperAdmin(bool|int|string|null $userId = false): bool
383 - {
384 405 return is_super_admin($userId);
385 406 }
386 407
387 408 /**
388 - * @see wp_get_current_user
409 + * @return WP_User
410 + * @see \wp_get_current_user()
389 411 */
390 412 public function getCurrentUser(): WP_User
391 413 {
392 414 if (function_exists('\wp_get_current_user') === false) {
@@ -396,50 +418,55 @@
396 418 return wp_get_current_user();
397 419 }
398 420
399 421 /**
400 - * @see get_allowed_mime_types
422 + * @param int|WP_User $user
423 + * @return array
424 + * @see \get_allowed_mime_types()
401 425 */
402 - public function getAllowedMimeTypes(WP_User|int|string|null $user = null): array
426 + public function getAllowedMimeTypes($user = null): array
403 427 {
404 428 return get_allowed_mime_types($user);
405 429 }
406 430
407 431 /**
408 - * @see wp_upload_dir
432 + * @param string $time
433 + * @param bool $createDir
434 + * @param bool $refreshCache
435 + * @return array
436 + * @see \wp_upload_dir()
409 437 */
410 - public function getUploadDir(?string $time = null, bool $createDir = true, bool $refreshCache = false): array
438 + public function getUploadDir($time = null, $createDir = true, $refreshCache = false): array
411 439 {
412 440 return wp_upload_dir($time, $createDir, $refreshCache);
413 441 }
414 442
415 443 /**
416 - * @see home_url
444 + * @param string $path
445 + * @param null|string $scheme
446 + * @return string
447 + * @see \home_url()
417 448 */
418 - public function getHomeUrl(string $path = '', ?string $scheme = null): string
449 + public function getHomeUrl($path = '', $scheme = null): string
419 450 {
420 451 return home_url($path, $scheme);
421 452 }
422 453
423 454 /**
424 - * @see site_url
455 + * @param string $path
456 + * @param null|string $scheme
457 + * @return string
458 + * @see \site_url();
425 459 */
426 - public function getSiteUrl(string $path = '', ?string $scheme = null): string
460 + public function getSiteUrl($path = '', $scheme = null): string
427 461 {
428 462 return site_url($path, $scheme);
429 463 }
430 464
431 465 /**
432 - * @see add_query_arg
466 + * @return string
467 + * @see \get_home_path()
433 468 */
434 - public function addQueryArg(array $arguments, string $url): string
435 - {
436 - return add_query_arg($arguments, $url);
437 - }
438 -
439 - /**
440 - * @see get_home_path
441 - */
442 469 public function getHomePath(): string
443 470 {
444 471 if (function_exists('\get_home_path') === false) {
445 472 require_once(ABSPATH . 'wp-admin/includes/file.php');
@@ -448,34 +475,41 @@
448 475 return get_home_path();
449 476 }
450 477
451 478 /**
452 - * @see wp_parse_id_list
479 + * @param array|string $list
480 + * @return array
481 + * @see \wp_parse_id_list()
453 482 */
454 - public function parseIdList(array|string|int $list): array
483 + public function parseIdList($list): array
455 484 {
456 485 return wp_parse_id_list($list);
457 486 }
458 487
459 488 /**
460 - * @see wp_die
489 + * @param string $message
490 + * @param string $title
491 + * @param array $arguments
492 + * @see \wp_die()
461 493 */
462 - #[NoReturn]
463 - public function wpDie(string $message = '', string $title = '', array $arguments = []): void
494 + public function wpDie($message = '', $title = '', array $arguments = [])
464 495 {
465 496 wp_die($message, $title, $arguments);
466 497 }
467 498
468 499 /**
469 - * @see is_feed
500 + * @param string|array $feeds
501 + * @return bool
502 + * @see \is_feed()
470 503 */
471 - public function isFeed(array|string|int $feeds = ''): bool
504 + public function isFeed($feeds = ''): bool
472 505 {
473 506 return is_feed($feeds);
474 507 }
475 508
476 509 /**
477 - * @see is_user_logged_in
510 + * @return bool
511 + * @see \is_user_logged_in()
478 512 */
479 513 public function isUserLoggedIn(): bool
480 514 {
481 515 return is_user_logged_in();
@@ -481,42 +515,45 @@
481 515 return is_user_logged_in();
482 516 }
483 517
484 518 /**
485 - * @see get_page_by_path
519 + * @param string $pagePath
520 + * @param string $output
521 + * @param string $postType
522 + * @return array|null|WP_Post
523 + * @see \get_page_by_path()
486 524 */
487 - public function getPageByPath(
488 - string $pagePath,
489 - string $output = OBJECT,
490 - string $postType = 'page'
491 - ): array|WP_Post|null {
525 + public function getPageByPath(string $pagePath, $output = OBJECT, $postType = 'page')
526 + {
492 527 return get_page_by_path($pagePath, $output, $postType);
493 528 }
494 529
495 530 /**
496 - * @see wp_redirect
531 + * @param string $location
532 + * @param int $status
533 + * @return bool
534 + * @see \wp_redirect()
497 535 */
498 - public function wpRedirect(string $location, int $status = 302): bool
536 + public function wpRedirect(string $location, $status = 302): bool
499 537 {
500 538 return wp_redirect($location, $status);
501 539 }
502 540
503 541 /**
504 - * @see wp_get_referer
542 + * @param bool|int|WP_Post $post
543 + * @param bool $leaveName
544 + * @param bool $sample
545 + * @return string The page permalink.
505 546 */
506 - public function getReferer(): string|false
547 + public function getPageLink($post = false, $leaveName = false, $sample = false): string
507 548 {
508 - return wp_get_referer();
509 - }
510 -
511 - public function getPageLink(
512 - bool|int|string|WP_Post $post = false,
513 - bool $leaveName = false,
514 - bool $sample = false
515 - ): string {
516 549 return get_page_link($post, $leaveName, $sample);
517 550 }
518 551
552 + /**
553 + * Returns the wp_query object.
554 + * @return WP_Query
555 + */
519 556 public function getWpQuery(): WP_Query
520 557 {
521 558 global $wp_query;
522 559 return $wp_query;
@@ -521,86 +558,64 @@
521 558 global $wp_query;
522 559 return $wp_query;
523 560 }
524 561
525 - public function isRestRequest(): bool
526 - {
527 - return defined('REST_REQUEST') === true && REST_REQUEST === true;
528 - }
529 -
530 - public function setRestRequestContext(bool $isEditingRequest): void
531 - {
532 - $this->restRequestDispatched = true;
533 - //Nested requests, like the ones for embedded objects, must not lower the context again.
534 - $this->editingRestRequestDetected = $this->editingRestRequestDetected || $isEditingRequest;
535 - }
536 -
537 - private function isReadingRestMethod(string $method): bool
538 - {
539 - return in_array(strtoupper($method), self::REST_READING_METHODS, true);
540 - }
541 -
542 - private function isEditingRestRequest(): bool
543 - {
544 - if ($this->isRestRequest() === false) {
545 - return false;
546 - }
547 -
548 - if ($this->restRequestDispatched === true) {
549 - return $this->editingRestRequestDetected;
550 - }
551 -
552 - //Undispatched requests only expose the raw data, so an editing request is assumed.
553 - return $this->isReadingRestMethod((string) ($_SERVER['REQUEST_METHOD'] ?? 'GET')) === false
554 - || ($_REQUEST['context'] ?? '') === 'edit';
555 - }
556 -
557 562 /**
558 - * @see is_admin
563 + * @return bool
564 + * @see \is_admin()
559 565 */
560 566 public function isAdmin(): bool
561 567 {
562 - //Ajax request are always identified as an administrative interface page
563 - if (wp_doing_ajax() === true || $this->isRestRequest() === true) {
568 + //Ajax request are always identified as administrative interface page
569 + if (wp_doing_ajax() === true || defined('REST_REQUEST') && REST_REQUEST) {
564 570 //So let's check if we are calling the ajax data for the frontend or backend
565 571 //If the referer is an admin url we are requesting the data for the backend
566 572 $adminUrl = get_admin_url();
567 - return str_starts_with((string)($_SERVER['HTTP_REFERER'] ?? ''), $adminUrl)
568 - || $this->isEditingRestRequest() === true;
573 + return (substr((string) ($_SERVER['HTTP_REFERER'] ?? ''), 0, strlen((string) $adminUrl)) === $adminUrl);
569 574 }
570 575
571 - //No ajax request just uses the normal function
576 + //No ajax request just use the normal function
572 577 return is_admin();
573 578 }
574 579
575 580 /**
576 - * @see wp_create_nonce
581 + * @param int|string $action
582 + * @return string
583 + * @see \wp_create_nonce()
577 584 */
578 - public function createNonce(int|string $action): string
585 + public function createNonce($action): string
579 586 {
580 587 return wp_create_nonce($action);
581 588 }
582 589
583 590 /**
584 - * @see wp_nonce_field
591 + * @param int|string $action
592 + * @param string $name
593 + * @param bool $referrer
594 + * @param bool $echo
595 + * @return string
596 + * @see \wp_nonce_field()
585 597 */
586 - public function getNonceField(
587 - int|string $action = -1,
588 - string $name = '_wpnonce',
589 - bool $referrer = true,
590 - bool $echo = true
591 - ): string {
598 + public function getNonceField($action = -1, $name = '_wpnonce', $referrer = true, $echo = true): string
599 + {
592 600 return wp_nonce_field($action, $name, $referrer, $echo);
593 601 }
594 602
595 603 /**
596 - * @see wp_verify_nonce
604 + * @param string|null $nonce
605 + * @param string|int $action
606 + * @return false|int
607 + * @see \wp_verify_nonce()
597 608 */
598 - public function verifyNonce(?string $nonce, int|string $action = -1): bool|int
609 + public function verifyNonce(?string $nonce, $action = -1)
599 610 {
600 611 return wp_verify_nonce($nonce, $action);
601 612 }
602 613
614 + /**
615 + * Returns the wordpress roles.
616 + * @return WP_Roles
617 + */
603 618 public function getRoles(): WP_Roles
604 619 {
605 620 global $wp_roles;
606 621 return $wp_roles;
@@ -606,9 +621,17 @@
606 621 return $wp_roles;
607 622 }
608 623
609 624 /**
610 - * @see add_menu_page
625 + * @param string $pageTitle
626 + * @param string $menuTitle
627 + * @param string $capability
628 + * @param string $menuSlug
629 + * @param mixed $function
630 + * @param string $iconUrl
631 + * @param null $position
632 + * @return string
633 + * @see \add_menu_page()
611 634 */
612 635 public function addMenuPage(
613 636 string $pageTitle,
614 637 string $menuTitle,
@@ -613,17 +636,24 @@
613 636 string $pageTitle,
614 637 string $menuTitle,
615 638 string $capability,
616 639 string $menuSlug,
617 - mixed $function = '',
618 - string $iconUrl = '',
619 - int|float|null $position = null
640 + $function = '',
641 + $iconUrl = '',
642 + $position = null
620 643 ): string {
621 644 return add_menu_page($pageTitle, $menuTitle, $capability, $menuSlug, $function, $iconUrl, $position);
622 645 }
623 646
624 647 /**
625 - * @see add_submenu_page
648 + * @param string $parentSlug
649 + * @param string $pageTitle
650 + * @param string $menuTitle
651 + * @param string $capability
652 + * @param string $menuSlug
653 + * @param string|callable $function
654 + * @return false|string
655 + * @see \add_submenu_page()
626 656 */
627 657 public function addSubMenuPage(
628 658 string $parentSlug,
629 659 string $pageTitle,
@@ -629,15 +659,22 @@
629 659 string $pageTitle,
630 660 string $menuTitle,
631 661 string $capability,
632 662 string $menuSlug,
633 - callable|string $function = ''
634 - ): bool|string {
663 + $function = ''
664 + ) {
635 665 return add_submenu_page($parentSlug, $pageTitle, $menuTitle, $capability, $menuSlug, $function);
636 666 }
637 667
638 668 /**
639 - * @see add_meta_box
669 + * @param string $id
670 + * @param string $title
671 + * @param callable $callback
672 + * @param null $screen
673 + * @param string $context
674 + * @param string $priority
675 + * @param null $callbackArguments
676 + * @see \add_meta_box()
640 677 */
641 678 public function addMetaBox(
642 679 string $id,
643 680 string $title,
@@ -642,75 +679,88 @@
642 679 string $id,
643 680 string $title,
644 681 callable $callback,
645 682 $screen = null,
646 - string $context = 'advanced',
647 - string $priority = 'default',
683 + $context = 'advanced',
684 + $priority = 'default',
648 685 $callbackArguments = null
649 - ): void {
686 + ) {
650 687 add_meta_box($id, $title, $callback, $screen, $context, $priority, $callbackArguments);
651 688 }
652 689
653 690 /**
654 - * @see get_pages
691 + * @param array|string $arguments
692 + * @return array|false
693 + * @see \get_pages()
655 694 */
656 - public function getPages(array|string|int $arguments): bool|array
695 + public function getPages($arguments)
657 696 {
658 697 return get_pages($arguments);
659 698 }
660 699
661 700 /**
662 - * @see wp_register_style
701 + * @param string $handle
702 + * @param string $source
703 + * @param array $depends
704 + * @param string|bool|null $version
705 + * @param string $media
706 + * @return bool
707 + * @see \wp_register_style()
663 708 */
664 - public function registerStyle(
665 - string $handle,
666 - string $source,
667 - array $depends = [],
668 - bool|string|null $version = false,
669 - string $media = 'all'
670 - ): bool {
709 + public function registerStyle(string $handle, string $source, $depends = [], $version = false, $media = 'all'): bool
710 + {
671 711 return wp_register_style($handle, $source, $depends, $version, $media);
672 712 }
673 713
674 714 /**
675 - * @see wp_register_script
715 + * @param string $handle
716 + * @param string $source
717 + * @param array $depends
718 + * @param string|bool|null $version
719 + * @param bool $inFooter
720 + * @return bool
721 + * @see \wp_register_script()
676 722 */
677 723 public function registerScript(
678 724 string $handle,
679 725 string $source,
680 - array $depends = [],
681 - bool|string|null $version = false,
682 - bool $inFooter = false
726 + $depends = [],
727 + $version = false,
728 + $inFooter = false
683 729 ): bool {
684 730 return wp_register_script($handle, $source, $depends, $version, $inFooter);
685 731 }
686 732
687 733 /**
688 - * @see wp_enqueue_style
734 + * @param string $handle
735 + * @param string $source
736 + * @param array $depends
737 + * @param string|bool|null $version
738 + * @param string $media
739 + * @see \wp_enqueue_style()
689 740 */
690 - public function enqueueStyle(
691 - string $handle,
692 - string $source = '',
693 - array $depends = [],
694 - bool|string|null $version = false,
695 - string $media = 'all'
696 - ): void {
741 + public function enqueueStyle(string $handle, $source = '', $depends = [], $version = false, $media = 'all')
742 + {
697 743 wp_enqueue_style($handle, $source, $depends, $version, $media);
698 744 }
699 745
700 746 /**
701 - * @see wp_enqueue_script
747 + * @param string $handle
748 + * @param string $source
749 + * @param array $depends
750 + * @param string|bool|null $version
751 + * @param bool $inFooter
752 + * @see \wp_enqueue_script()
702 753 */
703 - public function enqueueScript(
704 - string $handle,
705 - string $source = '',
706 - array $depends = [],
707 - bool|string|null $version = false,
708 - bool $inFooter = false
709 - ): void {
754 + public function enqueueScript(string $handle, $source = '', $depends = [], $version = false, $inFooter = false)
755 + {
710 756 wp_enqueue_script($handle, $source, $depends, $version, $inFooter);
711 757 }
712 758
759 + /**
760 + * Returns the wordpress meta boxes.
761 + * @return array
762 + */
713 763 public function getMetaBoxes(): array
714 764 {
715 765 global $wp_meta_boxes;
716 766 return $wp_meta_boxes;
@@ -715,9 +765,13 @@
715 765 global $wp_meta_boxes;
716 766 return $wp_meta_boxes;
717 767 }
718 768
719 - public function setMetaBoxes(array $wpMetaBoxes): void
769 + /**
770 + * Sets the wordpress meta boxes.
771 + * @param array $wpMetaBoxes
772 + */
773 + public function setMetaBoxes(array $wpMetaBoxes)
720 774 {
721 775 global $wp_meta_boxes;
722 776 $wp_meta_boxes = $wpMetaBoxes;
723 777 }
@@ -722,9 +776,11 @@
722 776 $wp_meta_boxes = $wpMetaBoxes;
723 777 }
724 778
725 779 /**
726 - * @see get_sites
780 + * @param array $arguments
781 + * @return array
782 + * @see \get_sites()
727 783 */
728 784 public function getSites(array $arguments = []): array
729 785 {
730 786 if (function_exists('\get_sites') === true && class_exists('\WP_Site_Query') === true) {
@@ -734,25 +790,33 @@
734 790 return [];
735 791 }
736 792
737 793 /**
738 - * @see apply_filters()
794 + * @param string $tag
795 + * @param mixed $value
796 + * @return mixed
797 + * @see \apply_filters()
739 798 */
740 - public function applyFilters(string $tag, mixed $value): mixed
799 + public function applyFilters(string $tag, $value)
741 800 {
742 801 return call_user_func_array('\apply_filters', func_get_args());
743 802 }
744 803
745 804 /**
746 - * @see get_bloginfo
805 + * @param string $show
806 + * @param string $filter
807 + * @return string
808 + * @see \get_bloginfo()
747 809 */
748 - public function getBlogInfo(string $show = '', string $filter = 'raw'): string
810 + public function getBlogInfo($show = '', $filter = 'raw'): string
749 811 {
750 812 return get_bloginfo($show, $filter);
751 813 }
752 814
753 815 /**
754 - * @see esc_html
816 + * @param string $text
817 + * @return string
818 + * @see \esc_html()
755 819 */
756 820 public function escHtml(string $text): string
757 821 {
758 822 return esc_html($text);
@@ -758,24 +822,29 @@
758 822 return esc_html($text);
759 823 }
760 824
761 825 /**
762 - * @see is_single
826 + * @param int|string|array $post
827 + * @return bool
828 + * @see \is_single()
763 829 */
764 - public function isSingle(array|string|int $post = ''): bool
830 + public function isSingle($post = ''): bool
765 831 {
766 832 return is_single($post);
767 833 }
768 834
769 835 /**
770 - * @see is_page
836 + * @param int|string|array $page
837 + * @return bool
838 + * @see \is_page()
771 839 */
772 - public function isPage(array|string|int $page = ''): bool
840 + public function isPage($page = ''): bool
773 841 {
774 842 return is_page($page);
775 843 }
776 844
777 845 /**
846 + * @return string
778 847 * @see \WP_PLUGIN_DIR
779 848 */
780 849 public function getPluginDir(): string
781 850 {
@@ -782,33 +851,42 @@
782 851 return WP_PLUGIN_DIR;
783 852 }
784 853
785 854 /**
786 - * @see plugins_url
855 + * @param string $path
856 + * @param string $plugin
857 + * @return string
858 + * @see \plugins_url()
787 859 */
788 - public function pluginsUrl(string $path = '', string $plugin = ''): string
860 + public function pluginsUrl($path = '', $plugin = ''): string
789 861 {
790 862 return plugins_url($path, $plugin);
791 863 }
792 864
793 865 /**
794 - * @see plugin_basename
866 + * @param $file
867 + * @return string
868 + * @see \plugin_basename()
795 869 */
796 - public function pluginBasename(string $file): string
870 + public function pluginBasename($file): string
797 871 {
798 872 return plugin_basename($file);
799 873 }
800 874
801 875 /**
802 - * @see wp_attachment_is_image
876 + * @param int|WP_Post $post
877 + * @return bool
878 + * @see \wp_attachment_is_image()
803 879 */
804 - public function attachmentIsImage(int|WP_Post $post): bool
880 + public function attachmentIsImage($post): bool
805 881 {
806 882 return wp_attachment_is_image($post);
807 883 }
808 884
809 885 /**
810 - * @see current_user_can
886 + * @param string $capability
887 + * @return bool
888 + * @see \current_user_can()
811 889 */
812 890 public function currentUserCan(string $capability): bool
813 891 {
814 892 return current_user_can($capability);
@@ -814,9 +892,11 @@
814 892 return current_user_can($capability);
815 893 }
816 894
817 895 /**
818 - * @see get_users
896 + * @param array $arguments
897 + * @return array
898 + * @see \get_users()
819 899 */
820 900 public function getUsers(array $arguments = []): array
821 901 {
822 902 return get_users($arguments);
@@ -830,9 +910,12 @@
830 910 global $wp_filter;
831 911 return $wp_filter;
832 912 }
833 913
834 - public function setFilters(array $filters): void
914 + /**
915 + * @param array $filters
916 + */
917 + public function setFilters(array $filters)
835 918 {
836 919 global $wp_filter;
837 920 $wp_filter = $filters;
838 921 }
@@ -837,15 +920,23 @@
837 920 $wp_filter = $filters;
838 921 }
839 922
840 923 /**
841 - * @see current_time
924 + * @param string $type
925 + * @param int $gmt
926 + * @return int|string
927 + * @see \current_time()
842 928 */
843 - public function currentTime(string $type, int $gmt = 0): int|string
929 + public function currentTime(string $type, $gmt = 0)
844 930 {
845 931 return current_time($type, $gmt);
846 932 }
847 933
934 + /**
935 + * Formats the date like wordpress does it.
936 + * @param string $date
937 + * @return string
938 + */
848 939 public function formatDate(string $date): string
849 940 {
850 941 $dateFormat = __('M j, Y @ H:i');
851 942 return date_i18n($dateFormat, strtotime($date));
@@ -851,33 +942,40 @@
851 942 return date_i18n($dateFormat, strtotime($date));
852 943 }
853 944
854 945 /**
855 - * @see register_widget
946 + * @param mixed $widgetClass
947 + * @see \register_widget()
856 948 */
857 - public function registerWidget(mixed $widgetClass): void
949 + public function registerWidget($widgetClass)
858 950 {
859 951 register_widget($widgetClass);
860 952 }
861 953
862 954 /**
863 - * @see wp_login_url
955 + * @param string $redirect
956 + * @param bool $forceReauth
957 + * @return string
958 + * @see \wp_login_url()
864 959 */
865 - public function wpLoginUrl(string $redirect = '', bool $forceReauth = false): string
960 + public function wpLoginUrl($redirect = '', $forceReauth = false): string
866 961 {
867 962 return wp_login_url($redirect, $forceReauth);
868 963 }
869 964
870 965 /**
871 - * @see wp_logout_url
966 + * @param string $redirect
967 + * @return string
968 + * @see \wp_logout_url()
872 969 */
873 - public function wpLogoutUrl(string $redirect = ''): string
970 + public function wpLogoutUrl($redirect = ''): string
874 971 {
875 972 return wp_logout_url($redirect);
876 973 }
877 974
878 975 /**
879 - * @see wp_registration_url
976 + * @return string
977 + * @see \wp_registration_url()
880 978 */
881 979 public function wpRegistrationUrl(): string
882 980 {
883 981 return wp_registration_url();
@@ -883,33 +981,42 @@
883 981 return wp_registration_url();
884 982 }
885 983
886 984 /**
887 - * @see wp_lostpassword_url
985 + * @param string $redirect
986 + * @return string
987 + * @see \wp_lostpassword_url()
888 988 */
889 - public function wpLostPasswordUrl(string $redirect = ''): string
989 + public function wpLostPasswordUrl($redirect = ''): string
890 990 {
891 991 return wp_lostpassword_url($redirect);
892 992 }
893 993
894 994 /**
895 - * @see add_shortcode
995 + * @param string $tag
996 + * @param callable $function
997 + * @see \add_shortcode()
896 998 */
897 - public function addShortCode(string $tag, callable $function): void
999 + public function addShortCode(string $tag, callable $function)
898 1000 {
899 1001 add_shortcode($tag, $function);
900 1002 }
901 1003
902 1004 /**
903 - * @see do_shortcode
1005 + * @param string $content
1006 + * @param bool $ignoreHtml
1007 + * @return string
1008 + * @see \do_shortcode()
904 1009 */
905 - public function doShortCode(string $content, bool $ignoreHtml = false): string
1010 + public function doShortCode(string $content, $ignoreHtml = false): string
906 1011 {
907 1012 return do_shortcode($content, $ignoreHtml);
908 1013 }
909 1014
910 1015 /**
911 - * @see attachment_url_to_postid
1016 + * @param string $url
1017 + * @return int
1018 + * @see \attachment_url_to_postid()
912 1019 */
913 1020 public function attachmentUrlToPostId(string $url): int
914 1021 {
915 1022 return attachment_url_to_postid($url);
@@ -915,9 +1022,10 @@
915 1022 return attachment_url_to_postid($url);
916 1023 }
917 1024
918 1025 /**
919 - * @see got_mod_rewrite
1026 + * @return bool
1027 + * @see \got_mod_rewrite()
920 1028 */
921 1029 public function gotModRewrite(): bool
922 1030 {
923 1031 if (function_exists('\got_mod_rewirte') === false) {
@@ -927,24 +1035,29 @@
927 1035 return got_mod_rewrite();
928 1036 }
929 1037
930 1038 /**
931 - * @see is_user_member_of_blog()
1039 + * @return bool
1040 + * @see \is_user_member_of_blog()
932 1041 */
933 1042 public function isUserMemberOfBlog(): bool
934 1043 {
935 - return is_user_member_of_blog();
1044 + return (bool) is_user_member_of_blog();
936 1045 }
937 1046
938 1047 /**
939 - * @see get_queried_object_id
1048 + * @return int
1049 + * @see \get_queried_object_id()
940 1050 */
941 1051 public function getQueriedObjectId(): int
942 1052 {
943 - return get_queried_object_id();
1053 + return (int) get_queried_object_id();
944 1054 }
945 1055
946 - public function getCurrentPost(): array|WP_Post|null
1056 + /**
1057 + * @return WP_Post|array|null
1058 + */
1059 + public function getCurrentPost()
947 1060 {
948 1061 global $post;
949 1062 return $post;
950 1063 }