The Beautiful Taxonomy Filters plugin is an easy and good-looking way to provide your visitors with filtering for your post types. With this you get a complete solution for adding filtering based on custom taxonomy terms/categories/tags. It will also automatically add rewrite rules for pretty looking filter URLs. It’s completely automatic, works without javascript and is based on the WordPress Plugin boilerplate for a standardized, organized and object-oriented codebase. It uses select2 for pretty looking and user friendly dropdowns but will fall back to ordinary ones if javascript is not supported. No more horrible looking URLs or hacky Javascript solutions Try it before installing it. Use the Live Preview button on this page for a temporary WordPress in your browser, already set up with a recipe archive and three taxonomies to filter on. Nothing is installed and nothing is saved. The one thing the preview cannot show you is the rewritten URL itself – see the FAQ for why. Features Activate filtering on any registered public custom post type. Exclude taxonomies you just don’t want the visitors to filter on. Beautifies the resulting URLs. You won’t see any /posttype/?taxonomy1=term. Instead you’ll see /posttype/taxonomy/term. The pretty URLs are much more SEO friendly so you’ll give a boost to those filtered pages. Just remember to use canonicals where it’s appropriate. BETA: Conditional dropdowns. Make sure your visitors never end up with empty filtered results. AJAX reloads the values in each dropdown based on previously selected values. Polylang compatible. Multisite compatible. No network settings at the moment. Comes with a complete functional filter module for you to put in your theme. Three alternatives for putting the filter modules in your theme: Widgets (Also lets you “hard set” a post type for use anywhere) do_action hooks (for granular control) Automagic setting which will magically place the modules in your archive from thin air. Wizards at work… Choose from different styles for the component, or disable styling and do it yourself in style.css! Just want to tweak a style? Add your custom CSS directly on the settings page. Many more settings for fine-tuning the filter modules behavior: A ”Clear all” link for the filter component. Choose between placeholders or “show all” in the dropdowns. Hide empty terms in the dropdowns. Show a post count next to the term name Disable select2 Show term description Disable headings you don’t want More to come! Ability to show your visitors information about their current active filtering and control the look of this. Allows for custom GET parameters to be included. Extend the filter your way with maybe a custom search-parameter or whatever you like. Many filters and actions for modifying the plugins behavior. For you control freaks out there… Languages English Swedish Spanish (Thanks to Juan Javier Moreno Restituto) Dutch (Thanks to Piet Bos) German (Thanks to Matthias Bonnes) French (Thanks to Brice Capobianco) Simplified Chinese (Thanks to Amos Lee) Portuguese (Thanks to Luis Martins) Portuguese Brasil (Thanks to Bruno Sousa) Catalan (Thanks to Maiol Xercavins) Swiss (Thanks to Raphael Hüni) Bulgarian (Thanks to Georgi Marokov) Romanian (Thanks to Roberto Tamas) Do you want to translate this plugin to another language? I recommend using POEdit (http://poedit.net/) or if you prefer to do it straight from the WordPress admin interface (https://wordpress.org/plugins/loco-translate/). When you’re done, send us the file(s) to
[email protected] and we’ll add it to the official plugin! Other Based on WordPress Plugin Boilerplate Uses Select2 to enhance dropdowns Featured on WP Tavern RiverTheme The WhiP (WPMU DEV) TotalPhotoshop API **Filters** These are the filters available to modify the behavior of the plugin. These all take at least 1 parameter which you must return beautiful_filters_dropdown_categories $args is an array of the arguments put into the wp_dropdown_categories function. $taxonomy is the current taxonomy. function modify_categories_dropdown( $args, $taxonomy ) { return $args; } add_filter( 'beautiful_filters_dropdown_categories', 'modify_categories_dropdown’, 10, 2 ); beautiful_filters_post_types $post_types is an array. Modifies the selected post types before being used. function modify_post_types( $post_types ) { return $post_types; } add_filter( 'beautiful_filters_post_types', 'modify_post_types', 10, 1 ); beautiful_filters_taxonomies $taxonomies is an array. Modifies the excluded taxonomies before being used. function modify_categories_dropdown( $taxonomies ) { return $taxonomies; } add_filter( 'beautiful_filters_taxonomies', 'modify_categories_dropdown', 10, 1 ); beautiful_filters_post_type_archive_slug $post_type_slug is the url segment used for the post type archive, both when building the filtered url and when creating the rewrite rules. $post_type is the name of the post type. The counterpart to beautiful_filters_taxonomy_rewrite_slug. The value you return is used both when the filtered url is built and when the rewrite rules are created, so it has to be the same in both places or the url won’t resolve. Watch out for one thing in particular: the rewrite rules are generated once and then cached in the rewrite_rules option, while the filtered url is built on every request. If you return a value that depends on request state, the current language being the obvious example, the cached rules were built under whatever state happened to exist when they were last flushed and the two won’t match. Use Polylang if you need the url to vary by language, the plugin generates language prefixed rewrite rules for it. function modify_post_type_archive_slug( $post_type_slug, $post_type ) { return $post_type_slug; } add_filter( 'beautiful_filters_post_type_archive_slug', 'modify_post_type_archive_slug', 10, 2 ); beautiful_filters_taxonomy_rewrite_slug $rewrite_slug is the url segment used for a taxonomy, both when building the filtered url and when creating the rewrite rules. $taxonomy is the name of the taxonomy. $post_type_slug is the archive slug of the post type being filtered. The value you return is used both when the filtered url is built and when the rewrite rules are created, so it has to be the same in both places or the url won’t resolve. It’s here for those of you who want full control over the url structure. function modify_taxonomy_rewrite_slug( $rewrite_slug, $taxonomy, $post_type_slug ) { return $rewrite_slug; } add_filter( 'beautiful_filters_taxonomy_rewrite_slug', 'modify_taxonomy_rewrite_slug', 10, 3 ); beautiful_filters_taxonomy_all_items_label $label is the string used as the “all terms” value, both for the “all” option in the dropdowns, the select2 placeholder and the value shown in the filter info module. $taxonomy is the name of the taxonomy. WordPress falls an unset all_items label back to the taxonomy name, so we build “All %s” from the taxonomy name whenever we spot that fallback. An all_items label you’ve actually registered is passed through untouched. Use this filter if you want a different string, or the plain taxonomy name we used before 2.6.0. function modify_taxonomy_all_items_label( $label, $taxonomy ) { return $label; } add_filter( 'beautiful_filters_taxonomy_all_items_label', 'modify_taxonomy_all_items_label', 10, 2 ); beautiful_filters_pre_related_terms $related_terms is null. Return anything else and the conditional dropdowns database query is skipped entirely and your value is used instead. $post_type is the name of the post type being filtered. $selects is an array of the currently selected taxonomies and terms, as sent by the browser. $taxonomies is an array of the taxonomy names of the post type being filtered. Use this one to point the conditional dropdowns at something other than the database, an external index for example. What you return has to be shaped exactly like the result of the query it replaces: an array of objects, each one with the properties term_count (the number of matching posts), term_id, term_name, term_slug and taxonomy. Return an empty array for “no matches”. Returning null leaves everything as it is. function replace_related_terms( $related_terms, $post_type, $selects, $taxonomies ) { $term = new stdClass(); $term->term_count = 3; $term->term_id = 12; $term->term_name = 'Spain'; $term->term_slug = 'spain'; $term->taxonomy = 'locations'; return array( $term ); } add_filter( 'beautiful_filters_pre_related_terms', 'replace_related_terms', 10, 4 ); beautiful_filters_related_terms_sql $sql is the finished SQL query used by the conditional dropdowns. $post_type is the name of the post type being filtered. $selects is an array of the currently selected taxonomies and terms, as sent by the browser. $taxonomies is an array of the taxonomy names of the post type being filtered. A word of warning: the query you get has already been through $wpdb->prepare(). Anything you splice into it is entirely your own responsibility, and any % characters in the string you return will not be processed again. If you only need to swap the query out for something else, use beautiful_filters_pre_related_terms instead. function modify_related_terms_sql( $sql, $post_type, $selects, $taxonomies ) { return $sql; } add_filter( 'beautiful_filters_related_terms_sql', 'modify_related_terms_sql', 10, 4 ); beautiful_filters_taxonomy_order $taxonomies is an array of the taxonomies slugs. $current_post_type is the post type we’re using the filter on. This must return the $taxonomies array. function moveElement(&$array, $a, $b) { $out = array_splice($array, $a, 1); array_splice($array, $b, 0, $out); } function custom_tax_ordering($taxonomies, $current_post_type){ moveElement($taxonomies, 2, 0); return $taxonomies; } add_filter('beautiful_filters_taxonomy_order', 'custom_tax_ordering'); beautiful_filters_dropdown_placeholder $placeholder is the string used for the placeholder. $taxonomy is the current taxonomy. In order to change the placeholders you must use this filter rather than the modify_categories_dropdown argument “show_option_all”. function modify_dropdown_placeholder( $placeholder, $taxonomy ) { return 'New placeholder'; } add_filter( 'beautiful_filters_dropdown_placeholder', 'modify_dropdown_placeholder', 10, 2 ); beautiful_filters_language Changes the language code for the current page load. function modify_current_language( $language ) { return 'sv'; } add_filter( 'beautiful_filters_language', 'modify_current_language' ); beautiful_filters_rtl Changes wether the page is RTL or not. function modify_current_language( $rtl ) { return true; } add_filter( 'beautiful_filters_rtl', 'modify_rtl' ); beautiful_filters_disable_fuzzy Disables select2 fuzzy search. particularly useful for terms that are all numbers. function disable_fuzzy_search( $boolean ) { return true; } add_filter('beautiful_filters_disable_fuzzy', 'disable_fuzzy_search', 10, 1); beautiful_filters_clear_all $bool is a boolean which decides if the ”Clear all” link should be used or not. $current_post_type is the current post type being filtered function modify_clear_all( $bool, $current_post_type ) { //Only add the clear all link to a specific posttype if($current_post_type == 'movies'){ $bool = true; } return $bool; } add_filter( 'beautiful_filters_clear_all', 'modify_clear_all', 10, 2 ); beautiful_filters_hide_empty $bool is a boolean which decides if empty terms should be displayed or not. $current_post_type is the current post type being filtered function modify_hide_empty( $bool, $current_post_type ) { return $bool; } add_filter( 'beautiful_filters_show_empty', 'modify_hide_empty', 10, 2 ); beautiful_filters_show_count $bool is a boolean which decides if post count should be displayed or not. $current_post_type is the current post type being filtered function modify_show_count( $bool, $current_post_type ) { return $bool; } add_filter( 'beautiful_filters_show_empty', 'modify_show_count', 10, 2 ); beautiful_filters_show_description $bool is a boolean which decides if term description should be displayed or not. $current_post_type is the current post type being filtered function modify_show_description( $bool, $current_post_type ) { return $bool; } add_filter( 'beautiful_filters_show_description', 'modify_show_description', 10, 2 ); beautiful_filters_dropdown_order $order is a string which defaults to ASC, other possible value is DESC. $taxonomy is the current taxonomy slug function modify_dropdown_order( $order, $taxonomy) { return $order; } add_filter( 'beautiful_filters_dropdown_order', 'modify_dropdown_order', 10, 2 ); beautiful_filters_dropdown_orderby $order is a string which defaults to NAME, other possible value is ID or SLUG. $taxonomy is the current taxonomy slug function modify_dropdown_orderby( $orderby, $taxonomy) { return $orderby; } add_filter( 'beautiful_filters_dropdown_orderby', 'modify_dropdown_orderby', 10, 2 ); beautiful_filters_dropdown_behaviour $behaviour is a string that should be either show_all_option or show_placeholder_option. $current_post_type is the current posttype name. Use this to modify the dropdown behaviour per posttype or just manually from functions.php function modify_dropdown_behaviour( $behaviour, $current_post_type) { return $orderby; } add_filter( 'beautiful_filters_dropdown_behaviour', 'modify_dropdown_behaviour', 10, 2 ); beautiful_filters_dropdown_behaviour $term_name is a string that have to be returned. $category is the term object. $depth is the level of depth for the current term starting at 0 (no parent). Use this to alter the output of the term name inside the dropdowns. //Add visual information when a terms are children/grandchildren etc. add_filter('beautiful_filters_term_name', 'custom_term_name', 10, 3); function custom_term_name($term_name, $category, $depth){ //We have indentation if($depth !== 0){ $indent = ''; //Add one – for each step down the hierarchy, like WP does in admin. for($i = 0; $i < $depth; $i++){ $indent .= '–'; } return $indent . ' ' . $term_name; } return $term_name; } beautiful_filters_taxonomy_label $label is the name of the taxonomy used as label to the dropdown. function modify_labels($label){ return $label; } add_filter('beautiful_filters_taxonomy_label', 'modify_labels', 10, 1); beautiful_filters_apply_button $string is the default string of the apply filters button. function modify_filter_button($string){ return 'Hej världen'; } add_filter('beautiful_filters_apply_button', 'modify_filter_button', 10, 1); beautiful_filters_clear_button $string is the default string of the apply filters button. function modify_clear_button($string){ return 'Hej världen'; } add_filter('beautiful_filters_clear_button', 'modify_clear_button', 10, 1); beautiful_filters_loader function my_custom_loader( $loader, $taxonomy, $posttype ){ return $loader; // $loader is an img tag } add_filter('beautiful_filters_loader', 'my_custom_loader', 10, 3); beautiful_filters_active_terms $terms is the terms string for the active filter info $taxonomy is the current taxonomy name function modify_active_taxonomy($terms, $taxonomy){ return $terms; } add_filter('beautiful_filters_active_terms', 'modify_active_taxonomy', 10, 2); beautiful_filters_disable_heading $bool is a boolean of either true (hide filterinfo heading) or false (show filterinfo heading) function toggle_filterinfo_heading($bool){ return true; } add_filter('beautiful_filters_disable_heading', 'toggle_filterinfo_heading'); beautiful_filters_info_heading $filter_heading is the default heading string function modify_filter_heading($filter_heading){ $filter_heading = 'Hej världen'; return $filter_heading; } add_filter('beautiful_filters_info_heading', 'modify_filter_heading'); beautiful_filters_disable_postcount $bool is a boolean of either true (hide filterinfo postcount) or false (show filterinfo postcount) function toggle_filterinfo_postcount($bool){ return true; } add_filter('beautiful_filters_disable_postcount', 'toggle_filterinfo_postcount'); beautiful_filters_info_postcount $postcount_paragraph is the default postcount string. You MUST add %d somewhere in the new string in order for the resulting number to appear. function modify_filterinfo_postcount($postcount_paragraph){ return 'Hej världen '; } add_filter('beautiful_filters_info_postcount', 'modify_filterinfo_postcount'); beautiful_filters_new_url Use this filter to manipulate the URL string of the filtered archive page that the visitor will be directed to. Since 2.6.0 the redirect goes through wp_safe_redirect(), so a URL you return that points at another domain won’t be followed and the visitor lands on the unfiltered archive instead. If you need to send people to another domain, add its host to WordPress’ own allowed_redirect_hosts filter. Polylang registers its language domains there already, so a domain per language setup keeps working without you doing anything. function modify_new_url($url){ return $url . '?filtered=yes'; } add_filter('beautiful_filters_new_url', 'modify_new_url'); beautiful_filters_selec2_minsearch $min_search is an integer. function change_minsearch_value($min_search){ //always show search return 1; } add_filter('beautiful_filters_selec2_minsearch', 'change_minsearch_value'); beautiful_filters_selec2_allowclear $bool is a boolean value of either true of false. Setting this to false disables the ability to remove the selection with the x-icon. function change_allowclear_value($bool){ //Disables the allow clear. return false; } add_filter('beautiful_filters_selec2_allowclear', 'change_allowclear_value'); **Actions** These are the actions you may use to extend the filter component. beautiful_actions_before_form $current_post_type is the post type which the filter component are currently using. Use this variable as …
