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