JezK
Edit File: class.bcn_widget.php
<?php /* Copyright 2015-2025 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 = breadcrumb_navxt::version; 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')); $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; } //Mandatory before widget junk echo wp_kses($args['before_widget'], wp_kses_allowed_html('post')); if(!empty($title)) { echo wp_kses($args['before_title'], wp_kses_allowed_html('post')) . esc_html($title) . wp_kses($args['after_title'], wp_kses_allowed_html('post')); } //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 received 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); } //Mandatory after widget junk echo wp_kses($args['after_widget'], wp_kses_allowed_html('post'));; } function update($new_instance, $old_instance) { //Filter out anything that could be invalid $old_instance['title'] = wp_strip_all_tags($new_instance['title']); $old_instance['pretext'] = wp_kses($new_instance['pretext'], $this->allowed_html); $old_instance['type'] = wp_strip_all_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 esc_html_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 esc_html_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 esc_html_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 esc_html_e('List', 'breadcrumb-navxt'); ?></option> <option value="microdata" <?php selected('microdata', $instance['type']);?>><?php esc_html_e('Schema.org BreadcrumbList (RDFa)', 'breadcrumb-navxt'); ?></option> <option value="microdata_wai_aria" <?php selected('microdata_wai_aria', $instance['type']);?>><?php esc_html_e('Schema.org BreadcrumbList (RDFa) with WAI-ARIA', 'breadcrumb-navxt'); ?></option> <option value="breadcrumblist_microdata" <?php selected('breadcrumblist_microdata', $instance['type']);?>><?php esc_html_e('Schema.org BreadcrumbList (microdata)', 'breadcrumb-navxt'); ?></option> <option value="plain" <?php selected('plain', $instance['type']);?>><?php esc_html_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 esc_html_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 esc_html_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 esc_html_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 esc_html_e('Ignore breadcrumb cache', 'breadcrumb-navxt'); ?></label><br /> </p> <?php } }