LegacyMetricsCompat.php
4.98 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
<?php
namespace SearchWP\Admin;
use SearchWP\Settings;
use SearchWP\Statistics;
use SearchWP\Utils;
/**
* Legacy version of Metrics extension compatibility class.
* This class has to be removed once Metrics v1.4.2 is released.
*
* @since 4.2.0
*/
class LegacyMetricsCompat {
/**
* Run LegacyMetricsCompat hooks.
*
* @since 4.2.0
*
* @return void
*/
public static function hooks() {
if ( ! defined( 'SEARCHWP_METRICS_VERSION' ) ) {
return;
}
// Run for the legacy version of Metrics extension only.
if ( version_compare( SEARCHWP_METRICS_VERSION, '1.4.1', '>' ) ) {
return;
}
$user_can = current_user_can( Settings::get_capability() ) ||
current_user_can( Statistics::get_capability() );
if ( ! $user_can ) {
return;
}
// Standalone dashboard page and main SearchWP menu page hooks.
add_action( 'admin_enqueue_scripts', [ __CLASS__, 'load_legacy_assets' ] );
add_action( 'searchwp\settings\nav\before', [ __CLASS__, 'remove_nav_tab' ] );
add_action( 'searchwp\options\submenu_pages', [ __CLASS__, 'modify_submenu_items' ] );
if ( current_user_can( Settings::get_capability() ) ) {
// Main SearchWP menu page hooks.
add_action( 'admin_menu', [ __CLASS__, 'redirect_metrics' ], 910 );
add_action( 'wp_before_admin_bar_render', [ __CLASS__, 'change_admin_bar_menu_metrics_url' ], 110 );
} else {
// Standalone dashboard page hooks.
add_action( 'searchwp\settings\page\title', [ __CLASS__, 'page_title' ] );
}
}
/**
* Enqueue legacy assets from a legacy version of Metrics extension.
*
* @param string $hook_suffix The current admin page.
*
* @since 4.2.0
*
* @return void
*/
public static function load_legacy_assets( $hook_suffix ) {
if ( $hook_suffix === 'searchwp_page_searchwp-metrics' ) {
do_action( 'admin_enqueue_scripts', 'dashboard_page_searchwp-metrics' );
}
}
/**
* Remove a NavTab registered by the legacy version of Metrics extension.
*
* @since 4.2.0
*
* @return void
*/
public static function remove_nav_tab() {
global $wp_filter;
if ( ! isset( $wp_filter['searchwp\settings\nav\statistics']->callbacks[10] ) ) {
return;
}
// Since we don't have an instance of SearchWP_Metrics stored, we need to iterate through filters.
foreach ( $wp_filter['searchwp\settings\nav\statistics']->callbacks[10] as $key => $callback ) {
if ( ! isset( $callback['function'][0], $callback['function'][1] ) ) {
continue;
}
if ( $callback['function'][1] !== 'settings_nav_tab' ) {
continue;
}
if ( ! ( $callback['function'][0] instanceof \SearchWP_Metrics ) ) {
continue;
}
unset( $wp_filter['searchwp\settings\nav\statistics']->callbacks[10][ $key ] );
break;
}
}
/**
* Change Statistics to Metrics in the main menu.
*
* @since 4.2.0
*
* @param array $submenu_pages Submenu pages config.
*
* @return array
*/
public static function modify_submenu_items( $submenu_pages ) {
if ( ! isset( $submenu_pages['statistics'] ) ) {
return $submenu_pages;
}
$submenu_pages['statistics']['menu_title'] = esc_html__( 'Metrics', 'searchwp' );
$submenu_pages['statistics']['menu_slug'] = 'searchwp-metrics';
$submenu_pages['statistics']['function'] = function () {
echo '<div id="searchwp-metrics"></div>';
};
if ( Utils::is_swp_admin_page( 'metrics' ) ) {
new NavTab(
[
'page' => 'metrics',
'tab' => 'metrics',
'label' => __( 'Metrics', 'searchwp' ),
'is_default' => true,
]
);
}
return $submenu_pages;
}
/**
* Redirect Metrics dashboard menu item to the SearchWP main menu.
*
* @since 4.2.0
*
* @return void
*/
public static function redirect_metrics() {
global $submenu;
if ( ! is_array( $submenu ) || ! array_key_exists( 'index.php', $submenu ) ) {
return;
}
// Override the link for the Metrics dashboard menu item.
foreach ( $submenu['index.php'] as $index => $dashboard_submenu ) {
if ( $dashboard_submenu[2] !== 'searchwp-metrics' ) {
continue;
}
$submenu['index.php'][ $index ][2] = esc_url_raw(
add_query_arg( [ 'page' => 'searchwp-metrics' ], admin_url( 'admin.php' ) )
);
break;
}
}
/**
* Change Metrics URL in the admin bar menu.
*
* @since 4.2.0
*
* @return void
*/
public static function change_admin_bar_menu_metrics_url() {
global $wp_admin_bar;
$menu_item = $wp_admin_bar->get_node( 'searchwp_metrics' );
if ( ! isset( $menu_item->href ) ) {
return;
}
$menu_item->href = esc_url( add_query_arg( [ 'page' => 'searchwp-metrics' ], admin_url( 'admin.php' ) ) );
$wp_admin_bar->add_node( $menu_item );
}
/**
* Metrics main page title.
*
* @since 4.2.2
*/
public static function page_title() {
?>
<h1 class="page-title">
<?php esc_html_e( 'SearchWP Metrics', 'searchwp' ); ?>
</h1>
<style>
.searchwp-metrics__title h1 {
display: none;
}
</style>
<?php
}
}