breadcrumb_navxt

The Breadcrumb NavXT breadcrumb navxt class.

Defined (1)

The class is defined in the following location(s).

/breadcrumb-navxt.php  
  1. class breadcrumb_navxt 
  2. { 
  3.     const version = '5.5.2'; 
  4.     protected $name = 'Breadcrumb NavXT'; 
  5.     protected $identifier = 'breadcrumb-navxt'; 
  6.     protected $unique_prefix = 'bcn'; 
  7.     protected $plugin_basename = null; 
  8.     protected $opt = null; 
  9.     protected $breadcrumb_trail = null; 
  10.     protected $admin = null; 
  11.     /** 
  12.      * Constructor for a new breadcrumb_navxt object 
  13.      *  
  14.      * @param bcn_breadcrumb_trail $breadcrumb_trail An instance of a bcn_breadcrumb_trail object to use for everything 
  15.      */ 
  16.     public function __construct(bcn_breadcrumb_trail $breadcrumb_trail) 
  17.     { 
  18.         //We get our breadcrumb trail object from our constructor 
  19.         $this->breadcrumb_trail = $breadcrumb_trail; 
  20.         //Grab defaults from the breadcrumb_trail object 
  21.         $this->opt = $this->breadcrumb_trail->opt; 
  22.         //We set the plugin basename here 
  23.         $this->plugin_basename = plugin_basename(__FILE__); 
  24.         //We need to add in the defaults for CPTs and custom taxonomies after all other plugins are loaded 
  25.         add_action('wp_loaded', array($this, 'wp_loaded'), 15); 
  26.         add_action('init', array($this, 'init')); 
  27.         //Register the WordPress 2.8 Widget 
  28.         add_action('widgets_init', create_function('', 'return register_widget("'. $this->unique_prefix . '_widget");')); 
  29.         //Load our network admin if in the network dashboard (yes is_network_admin() doesn't exist) 
  30.         if(defined('WP_NETWORK_ADMIN') && WP_NETWORK_ADMIN) 
  31.         { 
  32.             require_once(dirname(__FILE__) . '/class.bcn_network_admin.php'); 
  33.             //Instantiate our new admin object 
  34.             $this->admin = new bcn_network_admin($this->breadcrumb_trail, $this->plugin_basename); 
  35.         } 
  36.         //Load our main admin if in the dashboard, but only if we're not in the network dashboard (prevents goofy bugs) 
  37.         else if(is_admin()) 
  38.         { 
  39.             require_once(dirname(__FILE__) . '/class.bcn_admin.php'); 
  40.             //Instantiate our new admin object 
  41.             $this->admin = new bcn_admin($this->breadcrumb_trail, $this->plugin_basename); 
  42.         } 
  43.     } 
  44.     public function init() 
  45.     { 
  46.         add_filter('bcn_allowed_html', array($this, 'allowed_html'), 1, 1); 
  47.         //We want to run late for using our breadcrumbs 
  48.         add_filter('tha_breadcrumb_navigation', array($this, 'tha_compat'), 99); 
  49.     } 
  50.     public function allowed_html($tags) 
  51.     { 
  52.         $allowed_html = array( 
  53.                     'a' => array( 
  54.                         'href' => true,  
  55.                         'title' => true,  
  56.                         'class' => true,  
  57.                         'id' => true,  
  58.                         'media' => true,  
  59.                         'dir' => true,  
  60.                         'relList' => true,  
  61.                         'rel' => true,  
  62.                         'aria-hidden' => true,  
  63.                         'data-icon' => true,  
  64.                         'itemref' => true,  
  65.                         'itemid' => true,  
  66.                         'itemprop' => true,  
  67.                         'itemscope' => true,  
  68.                         'itemtype' => true,  
  69.                         'xmlns:v' => true,  
  70.                         'typeof' => true,  
  71.                         'property' => true,  
  72.                         'vocab' => true,  
  73.                         'translate' => true,  
  74.                         'lang' => true 
  75.  ),  
  76.                     'img' => array( 
  77.                         'alt' => true,  
  78.                         'align' => true,  
  79.                         'height' => true,  
  80.                         'width' => true,  
  81.                         'src' => true,  
  82.                         'srcset' => true,  
  83.                         'sizes' => true,  
  84.                         'id' => true,  
  85.                         'class' => true,  
  86.                         'aria-hidden' => true,  
  87.                         'data-icon' => true,  
  88.                         'itemref' => true,  
  89.                         'itemid' => true,  
  90.                         'itemprop' => true,  
  91.                         'itemscope' => true,  
  92.                         'itemtype' => true,  
  93.                         'xmlns:v' => true,  
  94.                         'typeof' => true,  
  95.                         'property' => true,  
  96.                         'vocab' => true,  
  97.                         'lang' => true 
  98.  ),  
  99.                     'span' => array( 
  100.                         'title' => true,  
  101.                         'class' => true,  
  102.                         'id' => true,  
  103.                         'dir' => true,  
  104.                         'align' => true,  
  105.                         'lang' => true,  
  106.                         'xml:lang' => true,  
  107.                         'aria-hidden' => true,  
  108.                         'data-icon' => true,  
  109.                         'itemref' => true,  
  110.                         'itemid' => true,  
  111.                         'itemprop' => true,  
  112.                         'itemscope' => true,  
  113.                         'itemtype' => true,  
  114.                         'xmlns:v' => true,  
  115.                         'typeof' => true,  
  116.                         'property' => true,  
  117.                         'vocab' => true,  
  118.                         'translate' => true,  
  119.                         'lang' => true 
  120.  ),  
  121.                     'h1' => array( 
  122.                         'title' => true,  
  123.                         'class' => true,  
  124.                         'id' => true,  
  125.                         'dir' => true,  
  126.                         'align' => true,  
  127.                         'lang' => true,  
  128.                         'xml:lang' => true,  
  129.                         'aria-hidden' => true,  
  130.                         'data-icon' => true,  
  131.                         'itemref' => true,  
  132.                         'itemid' => true,  
  133.                         'itemprop' => true,  
  134.                         'itemscope' => true,  
  135.                         'itemtype' => true,  
  136.                         'xmlns:v' => true,  
  137.                         'typeof' => true,  
  138.                         'property' => true,  
  139.                         'vocab' => true,  
  140.                         'translate' => true,  
  141.                         'lang' => true 
  142.  ),  
  143.                     'h2' => array( 
  144.                         'title' => true,  
  145.                         'class' => true,  
  146.                         'id' => true,  
  147.                         'dir' => true,  
  148.                         'align' => true,  
  149.                         'lang' => true,  
  150.                         'xml:lang' => true,  
  151.                         'aria-hidden' => true,  
  152.                         'data-icon' => true,  
  153.                         'itemref' => true,  
  154.                         'itemid' => true,  
  155.                         'itemprop' => true,  
  156.                         'itemscope' => true,  
  157.                         'itemtype' => true,  
  158.                         'xmlns:v' => true,  
  159.                         'typeof' => true,  
  160.                         'property' => true,  
  161.                         'vocab' => true,  
  162.                         'translate' => true,  
  163.                         'lang' => true 
  164.  ),  
  165.                     'meta' => array( 
  166.                         'content' => true,  
  167.                         'property' => true,  
  168.                         'vocab' => true,  
  169.                         'itemprop' => true 
  170.  ) 
  171.  ); 
  172.         return mtekk_adminKit::array_merge_recursive($tags, $allowed_html); 
  173.     } 
  174.     public function get_version() 
  175.     { 
  176.         return self::version; 
  177.     } 
  178.     public function wp_loaded() 
  179.     { 
  180.         breadcrumb_navxt::setup_options($this->opt); 
  181.     } 
  182.     public function uninstall() 
  183.     { 
  184.         $this->admin->uninstall(); 
  185.     } 
  186.     /** 
  187.      * Sets up the extended options for any CPTs, taxonomies or extensions 
  188.      *  
  189.      * @param array $opt The options array, passed by reference 
  190.      */ 
  191.     static public function setup_options(&$opt) 
  192.     { 
  193.         //Add custom post types 
  194.         breadcrumb_navxt::find_posttypes($opt); 
  195.         //Add custom taxonomy types 
  196.         breadcrumb_navxt::find_taxonomies($opt); 
  197.         //Let others hook into our settings 
  198.         $opt = apply_filters('bcn_settings_init', $opt); 
  199.     } 
  200.     /** 
  201.      * Places settings into $opts array, if missing, for the registered post types 
  202.      *  
  203.      * @param array $opts 
  204.      */ 
  205.     static function find_posttypes(&$opts) 
  206.     { 
  207.         global $wp_post_types, $wp_taxonomies; 
  208.         //Loop through all of the post types in the array 
  209.         foreach($wp_post_types as $post_type) 
  210.         { 
  211.             //We only want custom post types 
  212.             if(!$post_type->_builtin) 
  213.             { 
  214.                 if(!isset($opts['bpost_' . $post_type->name . '_taxonomy_referer'])) 
  215.                 { 
  216.                     //Default to not letting the refering page influence the referer 
  217.                     $opts['bpost_' . $post_type->name . '_taxonomy_referer'] = false; 
  218.                 } 
  219.                 //If the post type does not have settings in the options array yet, we need to load some defaults 
  220.                 if(!isset($opts['Hpost_' . $post_type->name . '_template']) || !$post_type->hierarchical && !isset($opts['Spost_' . $post_type->name . '_taxonomy_type'])) 
  221.                 { 
  222.                     //Add the necessary option array members 
  223.                     $opts['Hpost_' . $post_type->name . '_template'] = bcn_breadcrumb::get_default_template(); 
  224.                     $opts['Hpost_' . $post_type->name . '_template_no_anchor'] = bcn_breadcrumb::default_template_no_anchor; 
  225.                     if($post_type->has_archive == true || is_string($post_type->has_archive)) 
  226.                     { 
  227.                         $opts['bpost_' . $post_type->name . '_archive_display'] = true; 
  228.                     } 
  229.                     else 
  230.                     { 
  231.                         $opts['bpost_' . $post_type->name . '_archive_display'] = false;         
  232.                     } 
  233.                     //Default to not showing a post_root 
  234.                     $opts['apost_' . $post_type->name . '_root'] = 0; 
  235.                     //Default to not displaying a taxonomy 
  236.                     $opts['bpost_' . $post_type->name . '_taxonomy_display'] = false; 
  237.                     //Loop through all of the possible taxonomies 
  238.                     foreach($wp_taxonomies as $taxonomy) 
  239.                     { 
  240.                         //Check for non-public taxonomies 
  241.                         if(!apply_filters('bcn_show_tax_private', $taxonomy->public, $taxonomy->name)) 
  242.                         { 
  243.                             continue; 
  244.                         } 
  245.                         //Activate the first taxonomy valid for this post type and exit the loop 
  246.                         if($taxonomy->object_type == $post_type->name || in_array($post_type->name, $taxonomy->object_type)) 
  247.                         { 
  248.                             $opts['bpost_' . $post_type->name . '_taxonomy_display'] = true; 
  249.                             $opts['Spost_' . $post_type->name . '_taxonomy_type'] = $taxonomy->name; 
  250.                             break; 
  251.                         } 
  252.                     } 
  253.                     //If there are no valid taxonomies for this type, we default to not displaying taxonomies for this post type 
  254.                     if(!isset($opts['Spost_' . $post_type->name . '_taxonomy_type'])) 
  255.                     { 
  256.                         $opts['Spost_' . $post_type->name . '_taxonomy_type'] = 'BCN_DATE'; 
  257.                     } 
  258.                 } 
  259.             } 
  260.         } 
  261.     } 
  262.     /** 
  263.      * Places settings into $opts array, if missing, for the registered taxonomies 
  264.      *  
  265.      * @param $opts 
  266.      */ 
  267.     static function find_taxonomies(&$opts) 
  268.     { 
  269.         global $wp_taxonomies; 
  270.         //We'll add our custom taxonomy stuff at this time 
  271.         foreach($wp_taxonomies as $taxonomy) 
  272.         { 
  273.             //We only want custom taxonomies 
  274.             if(!$taxonomy->_builtin) 
  275.             { 
  276.                 //If the taxonomy does not have settings in the options array yet, we need to load some defaults 
  277.                 if(!isset($opts['Htax_' . $taxonomy->name . '_template'])) 
  278.                 { 
  279.                     //Add the necessary option array members 
  280.                     $opts['Htax_' . $taxonomy->name . '_template'] = __(sprintf('<span property="itemListElement" typeof="ListItem"><a property="item" typeof="WebPage" title="Go to the %%title%% %s archives." href="%%link%%" class="%%type%%"><span property="name">%%htitle%%</span></a><meta property="position" content="%%position%%"></span>', $taxonomy->labels->singular_name), 'breadcrumb-navxt'); 
  281.                     $opts['Htax_' . $taxonomy->name . '_template_no_anchor'] = __(sprintf('<span property="itemListElement" typeof="ListItem"><span property="name">%%htitle%%</span><meta property="position" content="%%position%%"></span>', $taxonomy->labels->singular_name), 'breadcrumb-navxt'); 
  282.                 } 
  283.             } 
  284.         } 
  285.     } 
  286.     /** 
  287.      * Hooks into the theme hook alliance tha_breadcrumb_navigation filter and replaces the trail 
  288.      * with one generated by Breadcrumb NavXT 
  289.      *  
  290.      * @param string $bradcrumb_trail The string breadcrumb trail that we will replace 
  291.      * @return string The Breadcrumb NavXT assembled breadcrumb trail 
  292.      */ 
  293.     public function tha_compat($breadcrumb_trail) 
  294.     { 
  295.         //Return our breadcrumb trail 
  296.         return $this->display(true); 
  297.     } 
  298.     /** 
  299.      * Function updates the breadcrumb_trail options array from the database in a semi intellegent manner 
  300.      *  
  301.      * @since  5.0.0 
  302.      */ 
  303.     private function get_settings() 
  304.     { 
  305.         //Grab the current settings for the current local site from the db 
  306.         $this->breadcrumb_trail->opt = wp_parse_args(get_option('bcn_options'), $this->opt); 
  307.         //If we're in multisite mode, look at the three BCN_SETTINGS globals 
  308.         if(is_multisite()) 
  309.         { 
  310.             if(defined('BCN_SETTINGS_USE_NETWORK') && BCN_SETTINGS_USE_NETWORK) 
  311.             { 
  312.                 //Grab the current network wide settings 
  313.                 $this->breadcrumb_trail->opt = wp_parse_args(get_site_option('bcn_options'), $this->opt); 
  314.             } 
  315.             else if(defined('BCN_SETTINGS_FAVOR_LOCAL') && BCN_SETTINGS_FAVOR_LOCAL) 
  316.             { 
  317.                 //Grab the current settings for the current local site from the db 
  318.                 $this->breadcrumb_trail->opt = wp_parse_args(get_option('bcn_options'), $this->breadcrumb_trail->opt); 
  319.             } 
  320.             else if(defined('BCN_SETTINGS_FAVOR_NETWORK') && BCN_SETTINGS_FAVOR_NETWORK) 
  321.             { 
  322.                 //Grab the current settings from the db 
  323.                 $this->breadcrumb_trail->opt = wp_parse_args(get_site_option('bcn_options'), get_option('bcn_options')); 
  324.             } 
  325.         } 
  326.     } 
  327.     /** 
  328.      * Outputs the breadcrumb trail 
  329.      *  
  330.      * @param bool $return Whether to return or echo the trail. 
  331.      * @param bool $linked Whether to allow hyperlinks in the trail or not. 
  332.      * @param bool $reverse Whether to reverse the output or not. 
  333.      */ 
  334.     public function display($return = false, $linked = true, $reverse = false) 
  335.     { 
  336.         $this->get_settings(); 
  337.         //Generate the breadcrumb trail 
  338.         $this->breadcrumb_trail->fill(); 
  339.         return $this->breadcrumb_trail->display($return, $linked, $reverse); 
  340.     } 
  341.     /** 
  342.      * Outputs the breadcrumb trail with each element encapsulated with li tags 
  343.      *  
  344.      * @since  3.2.0 
  345.      * @param  bool $return Whether to return or echo the trail. 
  346.      * @param  bool $linked Whether to allow hyperlinks in the trail or not. 
  347.      * @param  bool    $reverse Whether to reverse the output or not. 
  348.      */ 
  349.     public function display_list($return = false, $linked = true, $reverse = false) 
  350.     { 
  351.         $this->get_settings(); 
  352.         //Generate the breadcrumb trail 
  353.         $this->breadcrumb_trail->fill(); 
  354.         return $this->breadcrumb_trail->display_list($return, $linked, $reverse); 
  355.     } 
  356. }