menu-item.php
27.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
<?php
/**
* This class contains a number of static methods for working with individual menu items.
*
* Note: This class is not fully self-contained. Some of the methods will query global state.
* This is necessary because the interpretation of certain menu fields depends on things like
* currently registered hooks and the presence of specific files in admin/plugin folders.
*/
abstract class ameMenuItem {
const unclickableTemplateId = '>special:none';
const unclickableTemplateClass = 'ame-unclickable-menu-item';
const embeddedPageTemplateId = '>special:embed_page';
const embeddedPagePlaceholderHeading = '[Same as menu title]';
/**
* @var array A partial list of files in /wp-admin/. Correct as of WP 3.8-RC1, 2013.12.04.
* When trying to determine if a menu links to one of the default WP admin pages, it's faster
* to check this list than to hit the disk.
*/
private static $known_wp_admin_files = array(
'customize.php' => true, 'edit-comments.php' => true, 'edit-tags.php' => true, 'edit.php' => true,
'export.php' => true, 'import.php' => true, 'index.php' => true, 'link-add.php' => true,
'link-manager.php' => true, 'media-new.php' => true, 'nav-menus.php' => true, 'options-discussion.php' => true,
'options-general.php' => true, 'options-media.php' => true, 'options-permalink.php' => true,
'options-reading.php' => true, 'options-writing.php' => true, 'plugin-editor.php' => true,
'plugin-install.php' => true, 'plugins.php' => true, 'post-new.php' => true, 'profile.php' => true,
'privacy.php' => true,
'theme-editor.php' => true, 'themes.php' => true, 'tools.php' => true, 'update-core.php' => true,
'upload.php' => true, 'user-new.php' => true, 'users.php' => true, 'widgets.php' => true,
);
private static $mappable_parent_whitelist = '@^(?:profile|import|post-new|edit-tags)\.php@';
private static $cached_site_url = null;
private static $is_switch_hook_set = false;
/**
* Convert a WP menu structure to an associative array.
*
* @param array $item An menu item.
* @param int|string $position The position (index) of the the menu item.
* @param string|null $parent The slug of the parent menu that owns this item. Null for top level menus.
* @return array
*/
public static function fromWpItem($item, $position = 0, $parent = null) {
static $separator_count = 0;
$default_css_class = ($parent === null) ? 'menu-top' : '';
$item = array(
'menu_title' => strval($item[0]),
'access_level' => strval($item[1]), //= required capability
'file' => $item[2],
'page_title' => (isset($item[3]) ? strval($item[3]) : ''),
'css_class' => (isset($item[4]) ? strval($item[4]) : $default_css_class),
'hookname' => (isset($item[5]) ? strval($item[5]) : ''), //Used as the ID attr. of the generated HTML tag.
'icon_url' => (isset($item[6]) ? strval($item[6]) : 'dashicons-admin-generic'),
'position' => $position,
'parent' => $parent,
);
if ( is_numeric($item['access_level']) ) {
$dummyUser = new WP_User;
$item['access_level'] = $dummyUser->translate_level_to_cap($item['access_level']);
}
if ( $parent === null ) {
$item['separator'] = (strpos($item['css_class'], 'wp-menu-separator') !== false);
//WP 3.0 in multisite mode has two separators with the same filename. Fix by reindexing separators.
if ( $item['separator'] ) {
$item['file'] = 'separator_' . ($separator_count++);
}
} else {
//Submenus can't contain separators.
$item['separator'] = false;
}
//Flag plugin pages
$has_hook = (get_plugin_page_hook($item['file'], strval($parent)) != null);
$item['is_plugin_page'] = $has_hook;
if ( !$item['separator'] ) {
$item['url'] = self::generate_url($item['file'], strval($parent), $has_hook);
}
$item['template_id'] = self::template_id($item, $parent);
return array_merge(self::basic_defaults(), $item);
}
public static function basic_defaults() {
static $basic_defaults = null;
if ( $basic_defaults !== null ) {
return $basic_defaults;
}
$basic_defaults = array(
//Fields that apply to all menu items.
'page_title' => '',
'menu_title' => '',
'access_level' => 'read',
'extra_capability' => '',
'file' => '',
'page_heading' => '',
'position' => 0,
'parent' => null,
//Fields that apply only to top level menus.
'css_class' => 'menu-top',
'hookname' => '',
'icon_url' => 'dashicons-admin-generic',
'separator' => false,
'colors' => false,
'is_always_open' => false,
//Internal fields that may not map directly to WP menu structures.
'open_in' => 'same_window', //'new_window', 'iframe' or 'same_window' (the default)
'iframe_height' => 0,
'is_iframe_scroll_disabled' => false,
'template_id' => '', //The default menu item that this item is based on.
'is_plugin_page' => false,
'custom' => false,
'url' => '',
'embedded_page_id' => 0,
'embedded_page_blog_id' => function_exists('get_current_blog_id') ? get_current_blog_id() : 1,
);
return $basic_defaults;
}
public static function blank_menu() {
static $blank_menu = null;
if ( $blank_menu !== null ) {
return $blank_menu;
}
//Template for a basic menu item.
$blank_menu = array_fill_keys(array_keys(self::basic_defaults()), null);
$blank_menu = array_merge($blank_menu, array(
'items' => array(), //List of sub-menu items.
'grant_access' => array(), //Per-role and per-user access. Supersedes role_access.
'colors' => null,
'is_always_open' => null,
'custom' => false, //True if item is made-from-scratch and has no template.
'missing' => false, //True if our template is no longer present in the default admin menu. Note: Stored values will be ignored. Set upon merging.
'unused' => false, //True if this item was generated from an unused default menu. Note: Stored values will be ignored. Set upon merging.
'hidden' => false, //Hide/show the item. Hiding is purely cosmetic, the item remains accessible.
'hidden_from_actor' => array(), //Like the "hidden" flag, but per-role. Lets the user hide an item without changing its permissions.
'separator' => false, //True if the item is a menu separator.
'restrict_access_to_items' => false, //True = Deny access to all submenu items if the user doesn't have access to this item.
'had_access_before_hiding' => null, //Roles who had access to this item before the user clicked the "hide" button. Usually empty.
'defaults' => self::basic_defaults(),
));
return $blank_menu;
}
public static function custom_item_defaults() {
return array(
'menu_title' => 'Custom Menu',
'access_level' => 'read',
'extra_capability' => '',
'page_title' => '',
'css_class' => 'menu-top',
'hookname' => '',
'icon_url' => 'dashicons-admin-generic',
'open_in' => 'same_window',
'iframe_height' => 0,
'is_iframe_scroll_disabled' => false,
'is_plugin_page' => false,
'page_heading' => '',
'colors' => false,
'embedded_page_id' => 0,
'embedded_page_blog_id' => function_exists('get_current_blog_id') ? get_current_blog_id() : 1,
'is_always_open' => false,
);
}
/**
* Get the value of a menu/submenu field.
* Will return the corresponding value from the 'defaults' entry of $item if the
* specified field is not set in the item itself.
*
* @param array $item
* @param string $field_name
* @param mixed $default Returned if the requested field is not set and is not listed in $item['defaults']. Defaults to null.
* @return mixed Field value.
*/
public static function get($item, $field_name, $default = null){
if ( isset($item[$field_name]) ){
return $item[$field_name];
} else {
if ( isset($item['defaults'], $item['defaults'][$field_name]) ){
return $item['defaults'][$field_name];
} else {
return $default;
}
}
}
/**
* Generate or retrieve an ID that semi-uniquely identifies the template
* of the given menu item.
*
* Note that custom items (i.e. those that do not point to any of the default
* admin menu pages) have no template IDs.
*
* The ID is generated from the item's and its parent's file attributes.
* Since WordPress technically allows two copies of the same menu to exist
* in the same sub-menu, this combination is not necessarily unique.
*
* @param array|string $item The menu item in question.
* @param string|null $parent_file The parent menu. If omitted, $item['defaults']['parent'] will be used.
* @return string Template ID, or an empty string if this is a custom item.
*/
public static function template_id($item, $parent_file = null){
if (is_string($item)) {
return strval($parent_file) . '>' . $item;
}
if ( !empty($item['custom']) ) {
return '';
}
//Maybe it already has an ID?
$template_id = self::get($item, 'template_id');
if ( !empty($template_id) ) {
return $template_id;
}
if ( isset($item['defaults']['file']) ) {
$item_file = $item['defaults']['file'];
} else {
$item_file = self::get($item, 'file');
}
if ( $parent_file === null ) {
if ( isset($item['defaults']['parent']) ) {
$parent_file = $item['defaults']['parent'];
} else {
$parent_file = self::get($item, 'parent');
}
}
//Map known alternative parents to admin parent menus. This is necessary to ensure that
//certain menu items have the same template ID both for admins and for regular users.
static $inverse_parent_map = null;
global $_wp_real_parent_file;
if ( ($inverse_parent_map === null) && !empty($_wp_real_parent_file) && is_array($_wp_real_parent_file) ) {
$inverse_parent_map = array_flip($_wp_real_parent_file);
}
if ( isset($inverse_parent_map[$parent_file]) && (preg_match(self::$mappable_parent_whitelist, $parent_file) === 1) ) {
$parent_file = $inverse_parent_map[$parent_file];
}
//Special case: In WP 4.0+ the URL of the "Appearance -> Customize" item is different on every admin page.
//This is because the URL includes a "return" parameter that contains the current page's URL. It also makes
//the template ID different on every page, so it's impossible to identify the menu. To fix that, lets remove
//the "return" parameter from the ID.
if ( strpos($item_file, 'customize.php?') === 0 ) {
$item_file = remove_query_arg('return', $item_file);
}
//Special case: Remove the current site URL from fully qualified URLs.
//This way template IDs will still match if the menu configuration is imported on a different site.
if ( strpos($item_file, '://') !== false ) {
$site_url = self::get_site_url();
$site_url_length = strlen($site_url);
if (
($site_url_length > 0)
//Does the item URL start with the site URL?
&& (strncmp($item_file, $site_url, $site_url_length) === 0)
//Only cut off the site URL if there will be something left.
//We don't want the ID to be an empty string.
&& (strlen($item_file) > $site_url_length)
) {
//The site URL usually doesn't have a trailing slash, but sometimes it does,
//so we could end up either with "/wp-admin/foo.php" or "wp-admin/foo.php".
//For consistency, let's always prepend a slash to the result.
$item_file = '/' .ltrim(substr($item_file, $site_url_length), '/');
}
}
//Special case: A menu item can have an empty slug. This is technically very wrong, but it works (sort of)
//as long as the item has at least one submenu. This has happened at least once in practice. A user had
//a theme based on the Redux framework, and inexplicably the framework was configured to use an empty page slug.
if ( empty($item['separator']) ) {
if ( $item_file === '' ) {
$item_file = '[ame-no-slug]';
}
if ( $parent_file === '' ) {
$parent_file = '[ame-no-slug]';
}
}
return strval($parent_file) . '>' . $item_file;
}
/**
* Set all undefined menu fields to the default value.
*
* @param array $item Menu item in the plugin's internal form
* @return array
*/
public static function apply_defaults($item){
foreach($item as $key => $value){
//Is the field set?
if ($value === null){
//Use default, if available
if (isset($item['defaults'], $item['defaults'][$key])){
$item[$key] = $item['defaults'][$key];
}
}
}
return $item;
}
/**
* Apply custom menu filters to an item of the custom menu.
*
* Calls a 'custom_admin_$item_type' filter with the entire $item passed as the argument.
* Used when converting the current custom menu to a WP-format menu.
*
* @param array $item Associative array representing one menu item (either top-level or submenu).
* @param string $item_type 'menu' or 'submenu'
* @param mixed $extra Optional extra data to pass to hooks.
* @return array Filtered menu item.
*/
public static function apply_filters($item, $item_type, $extra = null){
return apply_filters("custom_admin_{$item_type}", $item, $extra);
}
/**
* Recursively normalize a menu item and all of its sub-items.
*
* This will also ensure that the item has all the required fields.
*
* @static
* @param array $item
* @return array
*/
public static function normalize($item) {
if ( isset($item['defaults']) ) {
$item['defaults'] = array_merge(
empty($item['custom']) ? self::basic_defaults() : self::custom_item_defaults(),
$item['defaults']
);
}
$item = array_merge(self::blank_menu(), $item);
$item['unused'] = false;
$item['missing'] = false;
$item['template_id'] = self::template_id($item);
//Items pointing to a default page can't have a custom file/URL.
if ( ($item['template_id'] !== '') && ($item['file'] !== null) ) {
if ( $item['file'] == $item['defaults']['file'] ) {
//Identical to default, so just set it to use that.
$item['file'] = null;
} else {
//Different file = convert to a custom item. Need to call fix_defaults()
//to fix other fields that are currently set to defaults custom items don't have.
$item['template_id'] = '';
}
}
$item['custom'] = $item['custom'] || ($item['template_id'] == '');
$item = self::fix_defaults($item);
//Older versions would allow the user to set the required capability directly.
//This was incorrect since for default menu items the default cap was *always*
//applied anyway, and the new cap was applied on top of that. We make that explicit
//by storing the custom cap in a separate field - extra_capability - and keeping
//access_level (required cap) at the default value.
if ( isset($item['defaults']) && $item['access_level'] !== null ) {
if ( empty($item['extra_capability']) ) {
$item['extra_capability'] = $item['access_level'];
}
$item['access_level'] = null;
}
//Convert per-role access settings to the more general grant_access format.
if ( isset($item['role_access']) ) {
foreach($item['role_access'] as $role_id => $has_access) {
$item['grant_access']['role:' . $role_id] = $has_access;
}
unset($item['role_access']);
}
//There's no need to store the default position if a custom position is set.
//The default position will not be used, and there's no option to reset the position to default.
if ( isset($item['position'], $item['defaults']['position']) && ($item['defaults']['position'] === $item['position'])) {
unset($item['defaults']['position']);
}
//The same goes for template ID.
if ( isset($item['template_id']) ) {
unset($item['defaults']['template_id']);
}
if ( isset($item['items']) ) {
foreach($item['items'] as $index => $sub_item) {
$item['items'][$index] = self::normalize($sub_item);
}
}
return $item;
}
/**
* Fix obsolete default values on custom items.
*
* In older versions of the plugin, each custom item had its own set of defaults.
* It was also possible to create a pseudo-custom item from a default item by
* freely overwriting its fields with custom values.
*
* The current version uses the same defaults for all custom items. To avoid data
* loss, we'll check for any mismatches and make such defaults explicit.
*
* @static
* @param array $item
* @return array
*/
private static function fix_defaults($item) {
if ( $item['custom'] && isset($item['defaults']) ) {
$new_defaults = self::custom_item_defaults();
foreach($item as $field => $value) {
$is_mismatch = is_null($value)
&& array_key_exists($field, $item['defaults'])
&& (
!array_key_exists($field, $new_defaults) //No default.
|| ($item['defaults'][$field] != $new_defaults[$field]) //Different default.
);
if ( $is_mismatch ) {
$item[$field] = $item['defaults'][$field];
}
}
$item['defaults'] = $new_defaults;
}
return $item;
}
/**
* Sanitize item properties.
*
* Strips disallowed HTML and invalid characters from many fields. For example, only users who
* have the "unfiltered_html" capability can use arbitrary HTML in menu titles.
*
* To avoid the performance hit of calling current_user_can('unfiltered_html') for every item,
* you can call it once and pass the result to this function.
*
* @param array $item Menu item in the internal format.
* @param bool|null $user_can_unfiltered_html
* @return array Sanitized menu item.
*/
public static function sanitize($item, $user_can_unfiltered_html = null) {
if ( $user_can_unfiltered_html === null ) {
$user_can_unfiltered_html = current_user_can('unfiltered_html');
}
if ( !$user_can_unfiltered_html ) {
$kses_fields = array('menu_title', 'page_title', 'file', 'page_heading');
foreach($kses_fields as $field) {
$value = self::get($item, $field);
if ( is_string($value) && !empty($value) && !self::is_default($item, $field) ) {
$item[$field] = wp_kses_post($value);
}
}
}
//Sanitize CSS class names. Note that the WP implementation of sanitize_html_class() is very basic
//and doesn't comply with the CSS2 spec, but that's probably OK in this case.
$css_class = self::get($item, 'css_class');
if ( !self::is_default($item, 'css_class') && is_string($css_class) && function_exists('sanitize_html_class') ) {
$item['css_class'] = implode(' ', array_map('sanitize_html_class', explode(' ', $css_class)));
}
//While menu capabilities are generally not displayed anywhere except this plugin (which already
//escapes them properly), lets sanitize them anyway in case another plugin displays them as-is.
$capability_fields = array('access_level', 'extra_capability');
foreach($capability_fields as $field) {
$value = self::get($item, $field);
if ( !self::is_default($item, $field) && is_string($value) ) {
$item[$field] = wp_strip_all_tags($value);
}
}
//Menu icons can be all kinds of stuff (dashicons, data URIs, etc), but they can't contain HTML.
//See /wp-admin/menu-header.php line #90 and onwards for how WordPress handles icons.
if ( !self::is_default($item, 'icon_url') ) {
$item['icon_url'] = wp_strip_all_tags($item['icon_url']);
}
//WordPress already sanitizes the menu ID (hookname) on display, but, again, lets clean it just in case.
if ( !self::is_default($item, 'hookname') ) {
//Regex from menu-header.php, WP 4.1.
$item['hookname'] = preg_replace('@[^a-zA-Z0-9_:.]@', '-', self::get($item, 'hookname'));
}
return $item;
}
/**
* Custom comparison function that compares menu items based on their position in the menu.
*
* @param array $a
* @param array $b
* @return int
*/
public static function compare_position($a, $b){
$result = floatval(self::get($a, 'position', 0)) - floatval(self::get($b, 'position', 0));
//Support for non-integer positions.
if ($result > 0) {
return 1;
} else if ($result < 0) {
return -1;
}
return 0;
}
/**
* Generate a URL for a menu item.
*
* @param string $item_slug
* @param string $parent_slug
* @param bool|null $has_hook
* @return string An URL relative to the /wp-admin/ directory.
*/
public static function generate_url($item_slug, $parent_slug = '', $has_hook = null) {
$menu_url = is_array($item_slug) ? self::get($item_slug, 'file') : $item_slug;
$parent_url = !empty($parent_slug) ? $parent_slug : 'admin.php';
//Workaround for components that HTML-entity-encode menu URLs. Most plugins and themes don't do that, but there's
//at least one plugin that does (WooCommerce). WP core also encodes some menu URLs (e.g. Appearance -> Header).
//We need a raw URL here.
$menu_url = html_entity_decode($menu_url);
if ( strpos($menu_url, '://') !== false ) {
return $menu_url;
}
if ( self::is_hook_or_plugin_page($menu_url, $parent_url, $has_hook) ) {
$parent_file = self::remove_query_from($parent_url);
$base_file = self::is_wp_admin_file($parent_file) ? html_entity_decode($parent_url) : 'admin.php';
//add_query_arg() might be more robust, but it's significantly slower.
$url = $base_file
. ((strpos($base_file, '?') === false) ? '?' : '&')
. 'page=' . $menu_url;
//Surprisingly, WordPress does NOT encode the menu slug when using it in a query parameter ("?page=slug").
//This allows plugins to use tricks like passing additional query parameters by simply appending them
//to the slug. For example, this works: "something¶m=foo".
} else {
$url = $menu_url;
}
return $url;
}
private static function is_hook_or_plugin_page($page_url, $parent_page_url = '', $hasHook = null) {
if ( empty($parent_page_url) ) {
$parent_page_url = 'admin.php';
}
$pageFile = self::remove_query_from($page_url);
if ( $hasHook === null ) {
$hasHook = (get_plugin_page_hook($page_url, $parent_page_url) !== null);
}
if ( $hasHook ) {
return true;
}
//Files in /wp-admin are part of WP core so they're not plugin pages.
if ( self::is_wp_admin_file($pageFile) ) {
return false;
}
/*
* Special case: Absolute paths.
*
* - add_submenu_page() applies plugin_basename() to the menu slug, so we don't need to worry about plugin
* paths. However, absolute paths that *don't* point point to the plugins directory can be a problem.
*
* - Due to a known PHP bug, certain invalid paths can crash PHP. See self::is_safe_to_append().
*
* - WP 3.9.2 and 4.0+ unintentionally break menu URLs like "foo.php?page=c:\a\b.php" because esc_url()
* interprets the part before the colon as an invalid protocol. As a result, such links have an empty URL
* on Windows (but they might still work on other OS).
*
* - Recent versions of WP won't let you load a PHP file from outside the plugins and mu-plugins directories
* with "admin.php?page=filename". See the validate_file() call in /wp-admin/admin.php. However, such filenames
* can still be used as unique slugs for menus with hook callbacks, so we shouldn't reject them outright.
* Related: https://core.trac.wordpress.org/ticket/10011
*/
$allowPathConcatenation = self::is_safe_to_append($pageFile);
$pluginFileExists = $allowPathConcatenation
&& ($page_url != 'index.php')
&& is_file(WP_PLUGIN_DIR . '/' . $pageFile);
if ( $pluginFileExists ) {
return true;
}
return false;
}
/**
* Check if a file exists inside the /wp-admin subdirectory.
*
* @param string $filename
* @return bool
*/
private static function is_wp_admin_file($filename) {
//Check our hard-coded list of admin pages first. It's measurably faster than
//hitting the disk with is_file().
if ( isset(self::$known_wp_admin_files[$filename]) ) {
return self::$known_wp_admin_files[$filename];
}
//Now actually check the filesystem.
$adminFileExists = self::is_safe_to_append($filename)
&& is_file(ABSPATH . 'wp-admin/' . $filename);
//Cache the result for later. We can generally expect more than one call per top level menu URL.
self::$known_wp_admin_files[$filename] = $adminFileExists;
return $adminFileExists;
}
/**
* Verify that it's safe to append a given filename to another path.
*
* If we blindly append an absolute path to another path, we can get something like "C:\a\b/wp-admin/C:\c\d.php".
* PHP 5.2.5 has a known bug where calling file_exists() on that kind of an invalid filename will cause
* a timeout and a crash in some configurations. See: https://bugs.php.net/bug.php?id=44412
*
* @param string $filename
* @return bool
*/
private static function is_safe_to_append($filename) {
return (substr($filename, 1, 1) !== ':'); //Reject "C:\whatever" and similar.
}
/**
* Check if a field is currently set to its default value.
*
* @param array $item
* @param string $field_name
* @return bool
*/
public static function is_default($item, $field_name) {
if ( isset($item[$field_name]) ){
return false;
} else {
return isset($item['defaults'], $item['defaults'][$field_name]);
}
}
public static function remove_query_from($url) {
$pos = strpos($url, '?');
if ( $pos !== false ) {
return substr($url, 0, $pos);
}
return $url;
}
/**
* Remove the number of pending updates or other count elements from a menu title.
*
* @param string $menuTitle
* @return string
*/
public static function remove_update_count($menuTitle) {
if ( (stripos($menuTitle, '<span') === false) || !class_exists('DOMDocument', false) ) {
return $menuTitle;
}
$dom = new DOMDocument();
$uniqueId = 'ame-rex-title-wrapper-' . time();
if ( @$dom->loadHTML('<div id="' . $uniqueId . '">' . $menuTitle . '</div>') ) {
/** @noinspection PhpComposerExtensionStubsInspection */
$xpath = new DOMXpath($dom);
$result = $xpath->query('//span[contains(@class,"update-plugins") or contains(@class,"awaiting-mod")]');
if ( $result->length > 0 ) {
//Remove all matched nodes. We must iterate backwards to prevent messing up the DOMNodeList.
for ($i = $result->length - 1; $i >= 0; $i--) {
$span = $result->item(0);
$span->parentNode->removeChild($span);
}
$innerHtml = '';
$children = $dom->getElementById($uniqueId)->childNodes;
//In theory, $children should always be a DOMNodeList, but there has been
//at least one report about the foreach() statement throwing a warning
//because $children was not iterable.
if ( $children instanceof Traversable ) {
foreach ($children as $child) {
$innerHtml .= $child->ownerDocument->saveHTML($child);
}
}
return $innerHtml;
}
}
return $menuTitle;
}
/**
* Get the current site URL.
*
* This is equivalent to calling the get_site_url() WordPress API function without
* arguments, except this method caches the result and doesn't run filters every time.
*
* @return string
*/
private static function get_site_url() {
if ( self::$cached_site_url !== null ) {
return self::$cached_site_url;
}
self::$cached_site_url = get_site_url();
//Clear the cache when WordPress switches to a different site.
if ( !self::$is_switch_hook_set ) {
self::$is_switch_hook_set = true;
add_action('switch_blog', array(__CLASS__, 'clear_per_site_cache'), 10, 0);
}
return self::$cached_site_url;
}
public static function clear_per_site_cache() {
self::$cached_site_url = null;
}
}