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