-
Notifications
You must be signed in to change notification settings - Fork 26
/
class.bcn_widget.php
151 lines (148 loc) · 8.8 KB
/
class.bcn_widget.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
<?php
/*
Copyright 2015-2024 John Havlik (email : john.havlik@mtekk.us)
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
require_once(dirname(__FILE__) . '/includes/block_direct_access.php');
class bcn_widget extends WP_Widget
{
const version = '7.4.0';
protected $allowed_html = array();
protected $defaults = array('title' => '', 'pretext' => '', 'type' => 'microdata', 'linked' => true, 'reverse' => false, 'front' => false, 'force' => false);
//Default constructor
function __construct()
{
//Filter allowed_html array to allow others to add acceptable tags
$this->allowed_html = apply_filters('bcn_allowed_html', wp_kses_allowed_html('post'));
//@see https://core.trac.wordpress.org/ticket/10527
if(!is_textdomain_loaded('breadcrumb-navxt'))
{
load_plugin_textdomain('breadcrumb-navxt', false, 'breadcrumb-navxt/languages');
}
$ops = array('classname' => 'widget_breadcrumb_navxt', 'description' => __('Adds a breadcrumb trail to your sidebar', 'breadcrumb-navxt'));
parent::__construct('bcn_widget', 'Breadcrumb NavXT', $ops);
}
function widget($args, $instance)
{
//Make sure we grab defaults in the case of out of date instance settings being sent
$instance = wp_parse_args((array) $instance, $this->defaults);
$instance['title'] = apply_filters('widget_title', $instance['title'], $instance, $this->id_base);
$instance['pretext'] = apply_filters('widget_text', $instance['pretext'], $instance);
$instance['pretext'] = apply_filters('bcn_widget_pretext', $instance['pretext'], $instance);
$title = apply_filters('widget_title', $instance['title'], $instance, $this->id_base);
//A bit of a hack but we need the DB settings to know if we should exit early
$opt = get_option('bcn_options');
//If we are on the front page and don't display on the front, return early
if($instance['front'] && is_front_page() && !(is_paged() && $opt['bpaged_display']))
{
return;
}
//Manditory before widget junk
echo $args['before_widget'];
if(!empty($title))
{
echo $args['before_title'] . $title . $args['after_title'];
}
//We'll want to switch between the two breadcrumb output types
if($instance['type'] === 'list')
{
//Display the list output breadcrumb
echo wp_kses($instance['pretext'], $this->allowed_html) . '<ol class="breadcrumb_trail breadcrumbs">';
bcn_display_list(false, $instance['linked'], $instance['reverse'], $instance['force']);
echo '</ol>';
}
else if($instance['type'] === 'microdata' || $instance['type'] === 'breadcrumblist_rdfa')
{
echo '<div class="breadcrumbs" vocab="https://schema.org/" typeof="BreadcrumbList">' . wp_kses($instance['pretext'], $this->allowed_html);
//Display the regular output breadcrumb
bcn_display(false, $instance['linked'], $instance['reverse'], $instance['force']);
echo '</div>';
}
else if($instance['type'] === 'breadcrumblist_microdata')
{
echo '<div class="breadcrumbs" itemscope itemtype="https://schema.org/BreadcrumbList">' . wp_kses($instance['pretext'], $this->allowed_html);
//Display the regular output breadcrumb
bcn_display(false, $instance['linked'], $instance['reverse'], $instance['force']);
echo '</div>';
}
else if($instance['type'] === 'plain')
{
//Display the pretext
echo wp_kses($instance['pretext'], $this->allowed_html);
//Display the regular output breadcrumb
bcn_display(false, $instance['linked'], $instance['reverse'], $instance['force']);
}
else if($instance['type'] === 'microdata_wai_aria')
{
echo '<nav aria-label="Breadcrumb" class="breadcrumbs" vocab="https://schema.org/" typeof="BreadcrumbList">' . wp_kses($instance['pretext'], $this->allowed_html);
//Display the regular output breadcrumb
bcn_display(false, $instance['linked'], $instance['reverse'], $instance['force']);
echo '</nav>';
}
else
{
//If we recieved a type that is not of the built in displays, it must be relegated to an extension plugin
do_action('bcn_widget_display_trail', $instance);
}
//Manditory after widget junk
echo $args['after_widget'];
}
function update($new_instance, $old_instance)
{
//Filter out anything that could be invalid
$old_instance['title'] = strip_tags($new_instance['title']);
$old_instance['pretext'] = wp_kses($new_instance['pretext'], $this->allowed_html);
$old_instance['type'] = strip_tags($new_instance['type']);
//Have to check more than if it is set as it appears this must effectively run twice since WordPress 5.8
$old_instance['linked'] = isset($new_instance['linked']) && $new_instance['linked'] !== false;
$old_instance['reverse'] = isset($new_instance['reverse']) && $new_instance['reverse'] !== false;
$old_instance['front'] = isset($new_instance['front']) && $new_instance['front'] !== false;
$old_instance['force'] = isset($new_instance['force']) && $new_instance['force'] !== false;
return $old_instance;
}
function form($instance)
{
$instance = wp_parse_args((array) $instance, $this->defaults);
?>
<p>
<label for="<?php echo esc_attr($this->get_field_id('title')); ?>"> <?php _e('Title:', 'breadcrumb-navxt'); ?></label>
<input class="widefat" type="text" name="<?php echo esc_attr($this->get_field_name('title')); ?>" id="<?php echo esc_attr($this->get_field_id('title')); ?>" value="<?php echo esc_attr($instance['title']);?>" />
</p>
<p>
<label for="<?php echo esc_attr($this->get_field_id('pretext')); ?>"> <?php _e('Text to show before the trail:', 'breadcrumb-navxt'); ?></label>
<input class="widefat" type="text" name="<?php echo esc_attr($this->get_field_name('pretext')); ?>" id="<?php echo esc_attr($this->get_field_id('pretext')); ?>" value="<?php echo esc_attr($instance['pretext']);?>" />
</p>
<p>
<label for="<?php echo esc_attr($this->get_field_id('type')); ?>"> <?php _e('Output trail as:', 'breadcrumb-navxt'); ?></label>
<select name="<?php echo esc_attr($this->get_field_name('type')); ?>" id="<?php echo esc_attr($this->get_field_id('type')); ?>">
<option value="list" <?php selected('list', $instance['type']);?>><?php _e('List', 'breadcrumb-navxt'); ?></option>
<option value="microdata" <?php selected('microdata', $instance['type']);?>><?php _e('Schema.org BreadcrumbList (RDFa)', 'breadcrumb-navxt'); ?></option>
<option value="microdata_wai_aria" <?php selected('microdata_wai_aria', $instance['type']);?>><?php _e('Schema.org BreadcrumbList (RDFa) with WAI-ARIA', 'breadcrumb-navxt'); ?></option>
<option value="breadcrumblist_microdata" <?php selected('breadcrumblist_microdata', $instance['type']);?>><?php _e('Schema.org BreadcrumbList (microdata)', 'breadcrumb-navxt'); ?></option>
<option value="plain" <?php selected('plain', $instance['type']);?>><?php _e('Plain', 'breadcrumb-navxt'); ?></option>
<?php do_action('bcn_widget_display_types', $instance);?>
</select>
</p>
<p>
<input class="checkbox" type="checkbox" name="<?php echo esc_attr($this->get_field_name('linked')); ?>" id="<?php echo esc_attr($this->get_field_id('linked')); ?>"<?php checked(true, $instance['linked']);?> />
<label for="<?php echo esc_attr($this->get_field_id('linked')); ?>"> <?php _e('Link the breadcrumbs', 'breadcrumb-navxt'); ?></label><br />
<input class="checkbox" type="checkbox" name="<?php echo esc_attr($this->get_field_name('reverse')); ?>" id="<?php echo esc_attr($this->get_field_id('reverse')); ?>"<?php checked(true, $instance['reverse']);?> />
<label for="<?php echo esc_attr($this->get_field_id('reverse')); ?>"> <?php _e('Reverse the order of the trail', 'breadcrumb-navxt'); ?></label><br />
<input class="checkbox" type="checkbox" name="<?php echo esc_attr($this->get_field_name('front')); ?>" id="<?php echo esc_attr($this->get_field_id('front')); ?>"<?php checked(true, $instance['front']);?> />
<label for="<?php echo esc_attr($this->get_field_id('front')); ?>"> <?php _e('Hide the trail on the front page', 'breadcrumb-navxt'); ?></label><br />
<input class="checkbox" type="checkbox" name="<?php echo esc_attr($this->get_field_name('force')); ?>" id="<?php echo esc_attr($this->get_field_id('force')); ?>"<?php checked(true, $instance['force']);?> />
<label for="<?php echo esc_attr($this->get_field_id('force')); ?>"> <?php _e('Ignore breadcrumb cache', 'breadcrumb-navxt'); ?></label><br />
</p>
<?php
}
}