woocommerce/includes/widgets/class-wc-widget-layered-nav...

408 lines
12 KiB
PHP
Raw Normal View History

2012-05-26 16:25:07 +00:00
<?php
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
2012-05-26 16:25:07 +00:00
/**
2012-08-14 17:37:50 +00:00
* Layered Navigation Widget
*
* @author WooThemes
* @category Widgets
* @package WooCommerce/Widgets
* @version 2.3.0
* @extends WC_Widget
2012-05-26 16:25:07 +00:00
*/
class WC_Widget_Layered_Nav extends WC_Widget {
2012-08-14 17:37:50 +00:00
/**
* Constructor
2012-08-14 17:37:50 +00:00
*/
public function __construct() {
$this->widget_cssclass = 'woocommerce widget_layered_nav';
$this->widget_description = __( 'Shows a custom attribute in a widget which lets you narrow down the list of products when viewing product categories.', 'woocommerce' );
$this->widget_id = 'woocommerce_layered_nav';
$this->widget_name = __( 'WooCommerce Layered Nav', 'woocommerce' );
2012-08-14 17:37:50 +00:00
2013-06-20 11:05:07 +00:00
parent::__construct();
}
/**
* update function.
*
* @see WP_Widget->update
*
2013-06-20 11:05:07 +00:00
* @param array $new_instance
* @param array $old_instance
*
2013-06-20 11:05:07 +00:00
* @return array
*/
public function update( $new_instance, $old_instance ) {
$this->init_settings();
2013-06-20 11:05:07 +00:00
return parent::update( $new_instance, $old_instance );
}
/**
* form function.
*
* @see WP_Widget->form
*
2013-06-20 11:05:07 +00:00
* @param array $instance
*/
public function form( $instance ) {
$this->init_settings();
2013-11-28 13:12:08 +00:00
parent::form( $instance );
2013-06-20 11:05:07 +00:00
}
/**
* Init settings after post types are registered
*/
public function init_settings() {
$attribute_array = array();
$attribute_taxonomies = wc_get_attribute_taxonomies();
if ( $attribute_taxonomies ) {
foreach ( $attribute_taxonomies as $tax ) {
if ( taxonomy_exists( wc_attribute_taxonomy_name( $tax->attribute_name ) ) ) {
$attribute_array[ $tax->attribute_name ] = $tax->attribute_name;
}
}
}
$this->settings = array(
'title' => array(
'type' => 'text',
'std' => __( 'Filter by', 'woocommerce' ),
'label' => __( 'Title', 'woocommerce' )
),
'attribute' => array(
'type' => 'select',
'std' => '',
'label' => __( 'Attribute', 'woocommerce' ),
'options' => $attribute_array
),
'display_type' => array(
'type' => 'select',
'std' => 'list',
'label' => __( 'Display type', 'woocommerce' ),
'options' => array(
'list' => __( 'List', 'woocommerce' ),
'dropdown' => __( 'Dropdown', 'woocommerce' )
)
),
'query_type' => array(
'type' => 'select',
'std' => 'and',
'label' => __( 'Query type', 'woocommerce' ),
'options' => array(
'and' => __( 'AND', 'woocommerce' ),
'or' => __( 'OR', 'woocommerce' )
)
),
);
2012-05-26 16:25:07 +00:00
}
2012-08-14 17:37:50 +00:00
/**
* widget function.
*
* @see WP_Widget
*
2012-08-14 17:37:50 +00:00
* @param array $args
* @param array $instance
*/
public function widget( $args, $instance ) {
2013-09-27 08:55:04 +00:00
global $_chosen_attributes;
2012-11-27 16:22:47 +00:00
if ( ! is_post_type_archive( 'product' ) && ! is_tax( get_object_taxonomies( 'product' ) ) ) {
2012-08-28 15:18:16 +00:00
return;
}
2012-08-14 17:37:50 +00:00
$current_term = is_tax() ? get_queried_object()->term_id : '';
$current_tax = is_tax() ? get_queried_object()->taxonomy : '';
$taxonomy = isset( $instance['attribute'] ) ? wc_attribute_taxonomy_name( $instance['attribute'] ) : $this->settings['attribute']['std'];
$query_type = isset( $instance['query_type'] ) ? $instance['query_type'] : $this->settings['query_type']['std'];
$display_type = isset( $instance['display_type'] ) ? $instance['display_type'] : $this->settings['display_type']['std'];
2012-05-26 16:25:07 +00:00
if ( ! taxonomy_exists( $taxonomy ) ) {
2012-08-28 15:18:16 +00:00
return;
}
2012-08-14 17:37:50 +00:00
$get_terms_args = array( 'hide_empty' => '1' );
$orderby = wc_attribute_orderby( $taxonomy );
switch ( $orderby ) {
case 'name' :
$get_terms_args['orderby'] = 'name';
$get_terms_args['menu_order'] = false;
break;
case 'id' :
$get_terms_args['orderby'] = 'id';
$get_terms_args['order'] = 'ASC';
$get_terms_args['menu_order'] = false;
break;
case 'menu_order' :
$get_terms_args['menu_order'] = 'ASC';
break;
}
$terms = get_terms( $taxonomy, $get_terms_args );
2012-08-14 17:37:50 +00:00
if ( 0 < count( $terms ) ) {
2012-11-27 16:22:47 +00:00
2012-05-26 16:25:07 +00:00
ob_start();
2012-11-27 16:22:47 +00:00
2012-08-28 15:18:16 +00:00
$found = false;
2012-11-27 16:22:47 +00:00
$this->widget_start( $args, $instance );
2012-08-14 17:37:50 +00:00
2012-05-26 16:25:07 +00:00
// Force found when option is selected - do not force found on taxonomy attributes
if ( ! is_tax() && is_array( $_chosen_attributes ) && array_key_exists( $taxonomy, $_chosen_attributes ) ) {
2013-06-20 10:21:31 +00:00
$found = true;
}
2012-08-14 17:37:50 +00:00
if ( 'dropdown' == $display_type ) {
2012-08-14 17:37:50 +00:00
2012-05-26 16:25:07 +00:00
// skip when viewing the taxonomy
if ( $current_tax && $taxonomy == $current_tax ) {
2012-08-14 17:37:50 +00:00
2012-05-26 16:25:07 +00:00
$found = false;
2012-08-14 17:37:50 +00:00
2012-05-26 16:25:07 +00:00
} else {
2012-08-14 17:37:50 +00:00
2012-08-28 15:18:16 +00:00
$taxonomy_filter = str_replace( 'pa_', '', $taxonomy );
2012-08-14 17:37:50 +00:00
$found = false;
2012-08-14 17:37:50 +00:00
echo '<select class="dropdown_layered_nav_' . $taxonomy_filter . '">';
2012-08-14 17:37:50 +00:00
echo '<option value="">' . sprintf( __( 'Any %s', 'woocommerce' ), wc_attribute_label( $taxonomy ) ) . '</option>';
2012-08-14 17:37:50 +00:00
2012-08-28 15:18:16 +00:00
foreach ( $terms as $term ) {
2012-08-14 17:37:50 +00:00
2012-05-26 16:25:07 +00:00
// If on a term page, skip that term in widget list
if ( $term->term_id == $current_term ) {
2012-08-28 15:18:16 +00:00
continue;
}
2012-08-14 17:37:50 +00:00
2012-05-26 16:25:07 +00:00
// Get count based on current view - uses transients
$transient_name = 'wc_ln_count_' . md5( sanitize_key( $taxonomy ) . sanitize_key( $term->term_taxonomy_id ) );
2012-08-14 17:37:50 +00:00
2012-05-26 16:25:07 +00:00
if ( false === ( $_products_in_term = get_transient( $transient_name ) ) ) {
2012-08-14 17:37:50 +00:00
2012-05-26 16:25:07 +00:00
$_products_in_term = get_objects_in_term( $term->term_id, $taxonomy );
2012-08-14 17:37:50 +00:00
set_transient( $transient_name, $_products_in_term, DAY_IN_SECONDS * 30 );
2012-05-26 16:25:07 +00:00
}
2012-08-14 17:37:50 +00:00
2012-08-28 15:18:16 +00:00
$option_is_set = ( isset( $_chosen_attributes[ $taxonomy ] ) && in_array( $term->term_id, $_chosen_attributes[ $taxonomy ]['terms'] ) );
2012-08-14 17:37:50 +00:00
2012-05-26 16:25:07 +00:00
// If this is an AND query, only show options with count > 0
if ( 'and' == $query_type ) {
2012-08-14 17:37:50 +00:00
2013-09-27 08:55:04 +00:00
$count = sizeof( array_intersect( $_products_in_term, WC()->query->filtered_product_ids ) );
2012-08-14 17:37:50 +00:00
if ( 0 < $count ) {
2012-08-28 15:18:16 +00:00
$found = true;
}
2012-08-14 17:37:50 +00:00
if ( 0 == $count && ! $option_is_set ) {
2012-08-28 15:18:16 +00:00
continue;
}
2012-08-14 17:37:50 +00:00
2012-05-26 16:25:07 +00:00
// If this is an OR query, show all options so search can be expanded
} else {
2012-08-14 17:37:50 +00:00
2013-09-27 08:55:04 +00:00
$count = sizeof( array_intersect( $_products_in_term, WC()->query->unfiltered_product_ids ) );
2012-08-14 17:37:50 +00:00
if ( 0 < $count ) {
2012-08-28 15:18:16 +00:00
$found = true;
}
2012-08-14 17:37:50 +00:00
2012-05-26 16:25:07 +00:00
}
2012-08-14 17:37:50 +00:00
echo '<option value="' . esc_attr( $term->term_id ) . '" ' . selected( isset( $_GET[ 'filter_' . $taxonomy_filter ] ) ? $_GET[ 'filter_' . $taxonomy_filter ] : '' , $term->term_id, false ) . '>' . esc_html( $term->name ) . '</option>';
2012-05-26 16:25:07 +00:00
}
2012-08-14 17:37:50 +00:00
2012-05-26 16:25:07 +00:00
echo '</select>';
2012-08-14 17:37:50 +00:00
wc_enqueue_js( "
jQuery( '.dropdown_layered_nav_$taxonomy_filter' ).change( function() {
var term_id = parseInt( jQuery( this ).val(), 10 );
location.href = '" . str_replace( array( '%\/page/[0-9]+%', '&amp;', '%2C' ), array( '', '&', ',' ), esc_js( add_query_arg( 'filtering', '1', remove_query_arg( array( 'page', 'filter_' . $taxonomy_filter ) ) ) ) ) . "&filter_$taxonomy_filter=' + ( isNaN( term_id ) ? '' : term_id );
2012-05-26 16:25:07 +00:00
});
" );
2012-08-14 17:37:50 +00:00
2012-05-26 16:25:07 +00:00
}
2012-08-14 17:37:50 +00:00
2012-05-26 16:25:07 +00:00
} else {
// List display
echo '<ul>';
2012-08-14 17:37:50 +00:00
2012-08-28 15:18:16 +00:00
foreach ( $terms as $term ) {
2012-08-14 17:37:50 +00:00
2012-05-26 16:25:07 +00:00
// Get count based on current view - uses transients
$transient_name = 'wc_ln_count_' . md5( sanitize_key( $taxonomy ) . sanitize_key( $term->term_taxonomy_id ) );
2012-08-14 17:37:50 +00:00
2012-05-26 16:25:07 +00:00
if ( false === ( $_products_in_term = get_transient( $transient_name ) ) ) {
2012-08-14 17:37:50 +00:00
2012-05-26 16:25:07 +00:00
$_products_in_term = get_objects_in_term( $term->term_id, $taxonomy );
2012-08-14 17:37:50 +00:00
2012-05-26 16:25:07 +00:00
set_transient( $transient_name, $_products_in_term );
}
2012-08-14 17:37:50 +00:00
2012-08-28 15:18:16 +00:00
$option_is_set = ( isset( $_chosen_attributes[ $taxonomy ] ) && in_array( $term->term_id, $_chosen_attributes[ $taxonomy ]['terms'] ) );
2012-08-14 17:37:50 +00:00
2013-09-27 08:55:04 +00:00
// skip the term for the current archive
if ( $current_term == $term->term_id ) {
2013-09-27 08:55:04 +00:00
continue;
}
2013-09-27 08:55:04 +00:00
2012-05-26 16:25:07 +00:00
// If this is an AND query, only show options with count > 0
if ( 'and' == $query_type ) {
2012-08-14 17:37:50 +00:00
2013-09-27 08:55:04 +00:00
$count = sizeof( array_intersect( $_products_in_term, WC()->query->filtered_product_ids ) );
2012-08-14 17:37:50 +00:00
if ( 0 < $count && $current_term !== $term->term_id ) {
2012-08-28 15:18:16 +00:00
$found = true;
}
2012-08-14 17:37:50 +00:00
if ( 0 == $count && ! $option_is_set ) {
2012-08-28 15:18:16 +00:00
continue;
}
2012-08-14 17:37:50 +00:00
2012-05-26 16:25:07 +00:00
// If this is an OR query, show all options so search can be expanded
2012-08-14 17:37:50 +00:00
} else {
$count = sizeof( array_intersect( $_products_in_term, WC()->query->unfiltered_product_ids ) );
2012-08-14 17:37:50 +00:00
if ( 0 < $count ) {
$found = true;
}
2012-05-26 16:25:07 +00:00
}
2012-08-14 17:37:50 +00:00
2012-08-28 15:18:16 +00:00
$arg = 'filter_' . sanitize_title( $instance['attribute'] );
2012-08-14 17:37:50 +00:00
2012-08-28 15:18:16 +00:00
$current_filter = ( isset( $_GET[ $arg ] ) ) ? explode( ',', $_GET[ $arg ] ) : array();
2012-08-14 17:37:50 +00:00
if ( ! is_array( $current_filter ) ) {
2012-08-28 15:18:16 +00:00
$current_filter = array();
}
2012-08-14 17:37:50 +00:00
2012-10-16 13:06:06 +00:00
$current_filter = array_map( 'esc_attr', $current_filter );
if ( ! in_array( $term->term_id, $current_filter ) ) {
2012-08-28 15:18:16 +00:00
$current_filter[] = $term->term_id;
}
2012-08-14 17:37:50 +00:00
2012-05-26 16:25:07 +00:00
// Base Link decided by current page
2012-08-28 15:18:16 +00:00
if ( defined( 'SHOP_IS_ON_FRONT' ) ) {
2012-05-26 16:25:07 +00:00
$link = home_url();
} elseif ( is_post_type_archive( 'product' ) || is_page( wc_get_page_id('shop') ) ) {
2012-08-28 15:18:16 +00:00
$link = get_post_type_archive_link( 'product' );
} else {
2012-05-26 16:25:07 +00:00
$link = get_term_link( get_query_var('term'), get_query_var('taxonomy') );
2012-08-28 15:18:16 +00:00
}
2012-08-14 17:37:50 +00:00
2012-05-26 16:25:07 +00:00
// All current filters
2012-08-28 15:18:16 +00:00
if ( $_chosen_attributes ) {
foreach ( $_chosen_attributes as $name => $data ) {
if ( $name !== $taxonomy ) {
2012-08-14 17:37:50 +00:00
// Exclude query arg for current term archive term
2012-08-28 15:18:16 +00:00
while ( in_array( $current_term, $data['terms'] ) ) {
$key = array_search( $current_term, $data );
unset( $data['terms'][$key] );
2012-05-26 16:25:07 +00:00
}
2012-08-14 17:37:50 +00:00
// Remove pa_ and sanitize
$filter_name = sanitize_title( str_replace( 'pa_', '', $name ) );
if ( ! empty( $data['terms'] ) ) {
$link = add_query_arg( 'filter_' . $filter_name, implode( ',', $data['terms'] ), $link );
}
2012-08-14 17:37:50 +00:00
if ( 'or' == $data['query_type'] ) {
$link = add_query_arg( 'query_type_' . $filter_name, 'or', $link );
}
2012-08-28 15:18:16 +00:00
}
}
}
2012-08-14 17:37:50 +00:00
2012-05-26 16:25:07 +00:00
// Min/Max
if ( isset( $_GET['min_price'] ) ) {
2012-05-26 16:25:07 +00:00
$link = add_query_arg( 'min_price', $_GET['min_price'], $link );
}
2012-08-28 15:18:16 +00:00
if ( isset( $_GET['max_price'] ) ) {
2012-05-26 16:25:07 +00:00
$link = add_query_arg( 'max_price', $_GET['max_price'], $link );
}
2012-08-14 17:37:50 +00:00
2014-02-24 15:45:43 +00:00
// Orderby
if ( isset( $_GET['orderby'] ) ) {
2014-02-24 15:45:43 +00:00
$link = add_query_arg( 'orderby', $_GET['orderby'], $link );
}
2014-02-24 15:45:43 +00:00
2012-05-26 16:25:07 +00:00
// Current Filter = this widget
2012-08-28 15:18:16 +00:00
if ( isset( $_chosen_attributes[ $taxonomy ] ) && is_array( $_chosen_attributes[ $taxonomy ]['terms'] ) && in_array( $term->term_id, $_chosen_attributes[ $taxonomy ]['terms'] ) ) {
2012-11-27 16:22:47 +00:00
2012-05-26 16:25:07 +00:00
$class = 'class="chosen"';
2012-08-14 17:37:50 +00:00
2012-05-26 16:25:07 +00:00
// Remove this term is $current_filter has more than 1 term filtered
2012-08-28 15:18:16 +00:00
if ( sizeof( $current_filter ) > 1 ) {
$current_filter_without_this = array_diff( $current_filter, array( $term->term_id ) );
$link = add_query_arg( $arg, implode( ',', $current_filter_without_this ), $link );
}
2012-08-14 17:37:50 +00:00
2012-08-28 15:18:16 +00:00
} else {
2012-11-27 16:22:47 +00:00
2012-08-28 15:18:16 +00:00
$class = '';
$link = add_query_arg( $arg, implode( ',', $current_filter ), $link );
2012-11-27 16:22:47 +00:00
2012-08-28 15:18:16 +00:00
}
2012-08-14 17:37:50 +00:00
2012-05-26 16:25:07 +00:00
// Search Arg
if ( get_search_query() ) {
2012-05-26 16:25:07 +00:00
$link = add_query_arg( 's', get_search_query(), $link );
}
2012-08-14 17:37:50 +00:00
2012-05-26 16:25:07 +00:00
// Post Type Arg
if ( isset( $_GET['post_type'] ) ) {
2012-05-26 16:25:07 +00:00
$link = add_query_arg( 'post_type', $_GET['post_type'], $link );
}
2012-08-14 17:37:50 +00:00
2012-05-26 16:25:07 +00:00
// Query type Arg
if ( $query_type == 'or' && ! ( sizeof( $current_filter ) == 1 && isset( $_chosen_attributes[ $taxonomy ]['terms'] ) && is_array( $_chosen_attributes[ $taxonomy ]['terms'] ) && in_array( $term->term_id, $_chosen_attributes[ $taxonomy ]['terms'] ) ) ) {
2012-08-28 15:18:16 +00:00
$link = add_query_arg( 'query_type_' . sanitize_title( $instance['attribute'] ), 'or', $link );
}
2012-08-14 17:37:50 +00:00
2012-08-28 15:18:16 +00:00
echo '<li ' . $class . '>';
2012-08-14 17:37:50 +00:00
2013-03-15 21:28:01 +00:00
echo ( $count > 0 || $option_is_set ) ? '<a href="' . esc_url( apply_filters( 'woocommerce_layered_nav_link', $link ) ) . '">' : '<span>';
2012-08-14 17:37:50 +00:00
2012-05-26 16:25:07 +00:00
echo $term->name;
2012-08-14 17:37:50 +00:00
2012-08-28 15:18:16 +00:00
echo ( $count > 0 || $option_is_set ) ? '</a>' : '</span>';
2012-08-14 17:37:50 +00:00
echo ' <span class="count">(' . $count . ')</span></li>';
2012-08-14 17:37:50 +00:00
2012-05-26 16:25:07 +00:00
}
2012-08-14 17:37:50 +00:00
echo '</ul>';
2012-08-14 17:37:50 +00:00
2012-05-26 16:25:07 +00:00
} // End display type conditional
2012-08-14 17:37:50 +00:00
$this->widget_end( $args );
2012-08-14 17:37:50 +00:00
if ( ! $found ) {
2012-12-29 13:51:51 +00:00
ob_end_clean();
} else {
2012-08-28 15:18:16 +00:00
echo ob_get_clean();
}
2012-05-26 16:25:07 +00:00
}
}
}