-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathnu_global_elements.php
496 lines (385 loc) · 15.7 KB
/
nu_global_elements.php
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
<?php
/*
Plugin Name: Northeastern Global Elements
Plugin URI: https://github.com/ITS-Digital-Technology/global-elements-wordpress
Description: Inserts the Northeastern University global header, footer, and TrustArc cookie consent manager. Requires wp_body_open() under the body tag to display the global header.
Author: Northeastern University ITS Web Solutions
Author URI: https://its.northeastern.edu
Version: 1.4.0
*/
if (!defined('ABSPATH')) { exit; }
const NU_GLOBAL_ELEMENTS_PLUGIN_VER = "1.4.0";
const NU_GLOBAL_ELEMENTS_PLUGIN_MANIFEST_URL = "https://its-digital-technology.github.io/global-elements-wordpress/manifest/info.json";
/**
* Get options values for plugin
*/
$nu_global_elements_options = get_option( 'nu_global_elements_option_name' );
/**
* Include global elements CSS, kernl UI and javascript from CDN on front end
*/
add_action('wp_head', function() { ?>
<link rel="stylesheet" href="https://global-packages.cdn.northeastern.edu/global-elements/dist/css/index.css">
<script src="https://global-packages.cdn.northeastern.edu/global-elements/dist/js/index.umd.js"></script>
<script src="https://global-packages.cdn.northeastern.edu/kernl-ui/dist/js/index.umd.js" defer></script>
<?php });
/**
* Include the global NU header, if it is not disabled in the options
*
* NOTE: There must be a wp_body_open() statement under the <body> tag,
* most likely in header.php of the theme.
*/
if (!isset($nu_global_elements_options['disable_global_header'])) {
add_action('wp_body_open', function() use ($nu_global_elements_options) {
// Determine whether to show the wordmark
$show_wordmark = isset($nu_global_elements_options['show_nu_wordmark']) && $nu_global_elements_options['show_nu_wordmark'];
// Determine whether to show the menu
$disable_menu = isset($nu_global_elements_options['disable_menu']) && $nu_global_elements_options['disable_menu'];
// Get the skipToMainSelector value, defaulting to "#main"
$skip_link_selector = isset($nu_global_elements_options['skip_link_selector']) ? $nu_global_elements_options['skip_link_selector'] : '#main';
// Create the x-data attribute dynamically with additional options
$x_data = sprintf(
'x-data="NUGlobalElements.header({ wordmark: %s, menu: %s, skipToMainSelector: \'%s\' })"',
$show_wordmark ? 'true' : 'false',
$disable_menu ? 'false' : 'true',
esc_js($skip_link_selector) // Escape for safe JavaScript insertion
);
// Output the HTML structure
echo sprintf(
'<div %s x-init="init()" style="height: 48px; background-color: black"></div>',
$x_data
);
}, 10);
}
/**
* Include the global NU footer, if it is not disabled in the options
*/
if (!isset($nu_global_elements_options['disable_global_footer'])) {
add_action('wp_footer', function() {
echo '<div x-data="NUGlobalElements.footer()" x-init="init()"></div>';
});
}
/**
* Include TrustArc, if it is not disabled in the options
*/
if (!isset($nu_global_elements_options['disable_trustarc'])){
if (isset($nu_global_elements_options['disable_global_footer'])){
add_action('wp_head', function() {
echo '<style>
#trustarc-global-element footer {padding-top: .6rem !important;}
#trustarc-global-element footer a {color: #ccc; text-decoration: none;}
</style>';
});
}
add_action('wp_footer', function() {
echo '<div id="trustarc-global-element" x-data="NUGlobalElements.trustarc()" x-init="init()"></div>';
});
}
// custom plugin styles
add_action('admin_enqueue_scripts', 'nu_global_elements_admin');
function nu_global_elements_admin($hook) {
if ( 'admin.php?page=nu-global-elements' == $hook ) {
return;
}
wp_enqueue_style('nu-global-elements-admin', plugins_url('nu-global-elements-admin.css', __FILE__ ));
}
/**
* Create plugin settings/options menu item, page and fields
*
* Retrieve options values with:
* $nu_global_elements_options = get_option( 'nu_global_elements_option_name' ); // Array of All Options
* $disable_global_header = $nu_global_elements_options['disable_global_header']; // Disable Global Header
* $disable_global_footer = $nu_global_elements_options['disable_global_footer']; // Disable Global Footer
* $disable_trustarc = $nu_global_elements_options['disable_trustarc']; // Disable TrustArc
*/
class NUGlobalElements {
private $nu_global_elements_options;
public function __construct() {
add_action( 'admin_menu', array( $this, 'nu_global_elements_add_plugin_page' ) );
add_action( 'admin_init', array( $this, 'nu_global_elements_page_init' ) );
}
public function nu_global_elements_add_plugin_page() {
add_menu_page(
'NU Global Elements', // page_title
'NU Global Elements', // menu_title
'manage_options', // capability
'nu-global-elements', // menu_slug
array( $this, 'nu_global_elements_create_admin_page' ), // function
'dashicons-admin-generic', // icon_url
99 // position
);
}
public function nu_global_elements_create_admin_page() {
$this->nu_global_elements_options = get_option( 'nu_global_elements_option_name' ); ?>
<div class="wrap">
<h2>NU Global Elements</h2>
<p>If you already display these elements via a method other than this plugin, you may use these options to avoid displaying them twice.</p>
<?php settings_errors(); ?>
<form method="post" action="options.php">
<?php
settings_fields( 'nu_global_elements_option_group' );
do_settings_sections( 'nu-global-elements-admin' );
submit_button();
?>
</form>
</div>
<?php }
public function nu_global_elements_page_init() {
register_setting(
'nu_global_elements_option_group', // option_group
'nu_global_elements_option_name', // option_name
array( $this, 'nu_global_elements_sanitize' ) // sanitize_callback
);
add_settings_section(
'nu_global_elements_setting_section', // id
'Settings', // title
array( $this, 'nu_global_elements_section_info' ), // callback
'nu-global-elements-admin' // page
);
add_settings_field(
'disable_global_header', // id
'Disable Global Header', // title
array( $this, 'disable_global_header_callback' ), // callback
'nu-global-elements-admin', // page
'nu_global_elements_setting_section' // section
);
add_settings_field(
'show_nu_wordmark', // id
'Show "Northeastern University" Wordmark next to large "N"
<p style="font-weight: normal">(uncheck if "Northeastern University" already exists in your website department logo)</p>
<img class="nuge-img-max-width" src="' . plugin_dir_url( __FILE__ ) . 'images/duplicate-wordmark-example.png" alt=""><br>
<p><i style="font-weight: normal">Avoid duplicate wordmarks in the global and local headers.</i></p>', // title
array( $this, 'show_nu_wordmark_callback' ), // callback
'nu-global-elements-admin', // page
'nu_global_elements_setting_section' // section
);
add_settings_field(
'skip_link_selector', // id
'Skip link selector
<p style="font-weight: normal">Enter the ID selector for the "Skip to main content" destination. Include the <code>#</code> (<i>e.g.</i> <code>#main</code>)</p>
<p style="font-weight: normal">Be sure to remove existing skip-to-main elements from your theme.</p>', // title
array( $this, 'skip_link_selector_callback' ), // callback
'nu-global-elements-admin', // page
'nu_global_elements_setting_section' // section
);
add_settings_field(
'disable_menu', // id
'Hide the "Explore Northeastern" menu', // title
array( $this, 'disable_menu_callback' ), // callback
'nu-global-elements-admin', // page
'nu_global_elements_setting_section' // section
);
add_settings_field(
'disable_global_footer', // id
'Disable Global Footer', // title
array( $this, 'disable_global_footer_callback' ), // callback
'nu-global-elements-admin', // page
'nu_global_elements_setting_section' // section
);
add_settings_field(
'disable_trustarc', // id
'Disable TrustArc Cookie Consent Manager', // title
array( $this, 'disable_trustarc_callback' ), // callback
'nu-global-elements-admin', // page
'nu_global_elements_setting_section' // section
);
}
public function nu_global_elements_sanitize($input) {
$sanitary_values = array();
if ( isset( $input['disable_global_header'] ) ) {
$sanitary_values['disable_global_header'] = $input['disable_global_header'];
}
if ( isset( $input['disable_global_footer'] ) ) {
$sanitary_values['disable_global_footer'] = $input['disable_global_footer'];
}
if ( isset( $input['disable_trustarc'] ) ) {
$sanitary_values['disable_trustarc'] = $input['disable_trustarc'];
}
if ( isset( $input['show_nu_wordmark'] ) ) {
$sanitary_values['show_nu_wordmark'] = $input['show_nu_wordmark'];
}
if ( isset( $input['skip_link_selector'] ) ) {
$sanitary_values['skip_link_selector'] = $input['skip_link_selector'];
}
if ( isset( $input['disable_menu'] ) ) {
$sanitary_values['disable_menu'] = $input['disable_menu'];
}
return $sanitary_values;
}
public function nu_global_elements_section_info() {
}
public function disable_global_header_callback() {
printf(
'<input type="checkbox" name="nu_global_elements_option_name[disable_global_header]" id="disable_global_header" value="disable_global_header" %s>',
( isset( $this->nu_global_elements_options['disable_global_header'] ) && $this->nu_global_elements_options['disable_global_header'] === 'disable_global_header' ) ? 'checked' : ''
);
}
public function show_nu_wordmark_callback() {
printf(
'<input type="checkbox" name="nu_global_elements_option_name[show_nu_wordmark]" id="show_nu_wordmark" value="show_nu_wordmark" %s>',
( isset( $this->nu_global_elements_options['show_nu_wordmark'] ) && $this->nu_global_elements_options['show_nu_wordmark'] === 'show_nu_wordmark' ) ? 'checked' : ''
);
}
public function skip_link_selector_callback() {
// Get the existing value of the skip link selector from the options
$skip_link_selector = isset($this->nu_global_elements_options['skip_link_selector']) ? $this->nu_global_elements_options['skip_link_selector'] : '#main';
// Output the text input field with the existing value
printf(
'<input type="text" name="nu_global_elements_option_name[skip_link_selector]" id="skip_link_selector" value="%s" class="nuge-skip-link-selector" />',
esc_attr($skip_link_selector) // Ensure the value is properly escaped
);
// Provide a description about what the input is for
echo '<p class="sr-only">Enter the ID selector for the "Skip to main content" destination (e.g., <code>#main</code>).</p>';
}
public function disable_menu_callback() {
printf(
'<input type="checkbox" name="nu_global_elements_option_name[disable_menu]" id="disable_menu" value="disable_menu" %s>',
( isset( $this->nu_global_elements_options['disable_menu'] ) && $this->nu_global_elements_options['disable_menu'] === 'disable_menu' ) ? 'checked' : ''
);
}
public function disable_global_footer_callback() {
printf(
'<input type="checkbox" name="nu_global_elements_option_name[disable_global_footer]" id="disable_global_footer" value="disable_global_footer" %s>',
( isset( $this->nu_global_elements_options['disable_global_footer'] ) && $this->nu_global_elements_options['disable_global_footer'] === 'disable_global_footer' ) ? 'checked' : ''
);
}
public function disable_trustarc_callback() {
printf(
'<input type="checkbox" name="nu_global_elements_option_name[disable_trustarc]" id="disable_trustarc" value="disable_trustarc" %s>',
( isset( $this->nu_global_elements_options['disable_trustarc'] ) && $this->nu_global_elements_options['disable_trustarc'] === 'disable_trustarc' ) ? 'checked' : ''
);
}
}
if ( is_admin() )
$nu_global_elements = new NUGlobalElements();
add_filter( 'plugin_action_links_global-elements-wordpress/nu_global_elements.php', 'nu_global_elements_link' );
function nu_global_elements_link( $links ) {
// Build and escape the URL.
$url = esc_url( add_query_arg(
'page',
'nu-global-elements',
get_admin_url() . 'admin.php'
) );
// Create the link.
$settings_link = "<a href='$url'>" . __( 'Settings' ) . '</a>';
// Adds the link to the end of the array.
array_push(
$links,
$settings_link
);
return $links;
}
/**
* Check for updates to this plugin and if available allow updating through WP admin plugin manager
*/
if( ! class_exists( 'UpdateChecker' ) ) {
class UpdateChecker{
public $plugin_slug;
public $version;
public $cache_key;
public $cache_allowed;
public function __construct() {
$this->plugin_slug = plugin_basename( __DIR__ );
$this->version = NU_GLOBAL_ELEMENTS_PLUGIN_VER;
$this->cache_key = 'global_elements_updater';
$this->cache_allowed = false;
add_filter( 'plugins_api', array( $this, 'info' ), 20, 3 );
add_filter( 'site_transient_update_plugins', array( $this, 'update' ) );
add_action( 'upgrader_process_complete', array( $this, 'purge' ), 10, 2 );
}
public function request(){
$remote = get_transient( $this->cache_key );
if( false === $remote || ! $this->cache_allowed ) {
$remote = wp_remote_get(
NU_GLOBAL_ELEMENTS_PLUGIN_MANIFEST_URL,
array(
'timeout' => 10,
'headers' => array(
'Accept' => 'application/json'
)
)
);
if(
is_wp_error( $remote )
|| 200 !== wp_remote_retrieve_response_code( $remote )
|| empty( wp_remote_retrieve_body( $remote ) )
) {
return false;
}
set_transient( $this->cache_key, $remote, DAY_IN_SECONDS );
}
$remote = json_decode( wp_remote_retrieve_body( $remote ) );
return $remote;
}
function info( $res, $action, $args ) {
// do nothing if you're not getting plugin information right now
if( 'plugin_information' !== $action ) {
return $res;
}
// do nothing if it is not our plugin
if( $this->plugin_slug !== $args->slug ) {
return $res;
}
// get updates
$remote = $this->request();
if( ! $remote ) {
return $res;
}
$res = new stdClass();
$res->name = $remote->name;
$res->slug = $remote->slug;
$res->version = $remote->version;
$res->tested = $remote->tested;
$res->requires = $remote->requires;
$res->author = $remote->author;
$res->author_profile = $remote->author_profile;
$res->download_link = $remote->download_url;
$res->trunk = $remote->download_url;
$res->requires_php = $remote->requires_php;
$res->last_updated = $remote->last_updated;
$res->sections = array(
'description' => $remote->sections->description,
'installation' => $remote->sections->installation,
'changelog' => $remote->sections->changelog
);
if( ! empty( $remote->banners ) ) {
$res->banners = array(
'low' => $remote->banners->low,
'high' => $remote->banners->high
);
}
return $res;
}
public function update( $transient ) {
if ( empty($transient->checked ) ) {
return $transient;
}
$remote = $this->request();
if(
$remote
&& version_compare( $this->version, $remote->version, '<' )
&& version_compare( $remote->requires, get_bloginfo( 'version' ), '<=' )
&& version_compare( $remote->requires_php, PHP_VERSION, '<' )
) {
$res = new stdClass();
$res->slug = $this->plugin_slug;
$res->plugin = plugin_basename( __FILE__ );
$res->new_version = $remote->version;
$res->tested = $remote->tested;
$res->package = $remote->download_url;
$transient->response[ $res->plugin ] = $res;
}
return $transient;
}
public function purge( $upgrader, $options ){
if (
$this->cache_allowed
&& 'update' === $options['action']
&& 'plugin' === $options[ 'type' ]
) {
// just clean the cache when new plugin version is installed
delete_transient( $this->cache_key );
}
}
}
new UpdateChecker();
}