Dynamic Post Filter Parameters
Note: This shortcode is also available as Gutenberg block. You can configure the block without using any code or parameters.
Note: This shortcode or block can only be used once on a page (including widgets).
Shortcode
[tag_groups_dpf]
From the upcoming version 1.19.0, posts can be displayed separated from the menu. Simply use in this shortcode separate=1 and add a second shortcode:
[tag_groups_dpf_body]Example
[tag_groups_dpf include=1,2,3,5 open=1,2,3,5 caching_time=60 persistent_filter=60 pager=1 display_amount=1 transition=fade]
Data Types
- string: A text. For identifiers that won’t be visible to visitors you often have to replace spaces with _ or -. If the string contains spaces, you need to wrap it in quotes.
- integer: A number without decimal places.
- 0 or 1: 0 turns the feature off and 1 on.
Parameters
Tags and Terms
taxonomy
Restrict the tags only to these taxonomies. Available are only taxonomies that have been activated in the Settings.
| accepted values | default | example shortcode |
|---|---|---|
| comma-separated list of taxonomy names | Taxonomies selected in the settings under “Basics”. | taxonomy=post_tag,product_tag |
operator
How the tags should be logically connected. Possible values are “IN” (At least one tag matches.), “AND” (All tags match.) and “IN AND” (At least one tag from each group matches).
| accepted values | default | example shortcode |
|---|---|---|
| string | IN | operator="IN AND" |
Groups
include
Tag groups that will be selectable by visitors. In the short code you use the IDs, which you find in the left column in the list of groups. Empty or not used means that all tag groups will be used.
| accepted values | default | example shortcode |
|---|---|---|
| comma-separated list of integers | empty (=all) | include=1,5,9 |
open
Tag groups that are initially open. If you use include, then all selected groups must also be included. Empty or not used means that all tag groups will be open.
| accepted values | default | example shortcode |
|---|---|---|
| comma-separated list of integers | empty (=all) | open=1,9 |
hide_close_buttons
Disables the possibility to remove the input fields of groups. You can use that option together with the include and open parameters if you want to show a fixed set of groups that cannot be altered by visitors.
| accepted values | default | example shortcode |
|---|---|---|
| integer | 0 | hide_close_buttons=1 |
sumoselect
Changes the default select menu to a more stylish one.
| accepted values | default | example shortcode |
|---|---|---|
| integer | 1 | sumoselect=0 |
groups_only
Skip the tag selection and display all products that match the selected groups.
| accepted values | default | example shortcode |
|---|---|---|
| integer | 0 | groups_only=1 |
Posts
caching_time
Time in minutes that results remain in the cache.
| accepted values | default | example shortcode |
|---|---|---|
| integer | 10 | caching_time=10 |
posts_per_page
How many posts appear under the filter. Use -1 to show all.
Please note that high numbers of posts may impact the performance.
Tip: If you use the parameter “display_amount” you can reduce the additional database request by using posts_per_page=-1 instead of a high number of posts.
| accepted values | default | example shortcode |
|---|---|---|
| integer | 5 | posts_per_page=10 |
pager
If the pager is enabled then visitors can load the next or previous page.
| accepted values | default | example shortcode |
|---|---|---|
| integer | 0 | pager=1 |
orderby
Which field to use for sorting.
| option | description |
|---|---|
| author | |
| date | |
| modified | |
| title | |
| comment_count |
| accepted values | default | example shortcode |
|---|---|---|
| string | date | orderby=title |
order
Whether to sort the posts in ascending or descending order. Ascending order also means from oldest to newest.
| accepted values | default | example shortcode |
|---|---|---|
| string | DESC | order=asc |
display_amount
Whether to display a line that shows the total amount of posts.
| accepted values | default | example shortcode |
|---|---|---|
| 0 or 1 | 0 | display_amount=1 |
template
HTML code that contains some placeholders. Leave empty to use the default template. It is recommended to edit it in the settings.
The default template shows every post with a thumbnail – see below. Possible placeholders are: {post_id}, {post_title}, {post_guid} (link to the post, {post_excerpt} (automatically generated), {post_excerpt_html} (preserves most common html tags), {post_date}, {post_author}, {image_src} or {image_src|100×100} (followed by the dimensions – will create also width and height attributes), {image_alt}, {post_category}. Make sure that single or double quotes appear only once as initial and final delimiters, while the other type of quotes can be used inside the template code.
image_src also accepts percentages or “auto” as values. If you want to use pixels, you enter the number without any “px”
| accepted values | default | example shortcode |
|---|---|---|
| string | see below | template='<a href=“{post_guid}”>{post_title}</a>' |
Example for an image tag:
<img src=”{image_src|100×150}” alt=”{image_alt}” class=”tg-entry-image” />Default template:
<header class="tg-entry-header">
<a href="{permalink}" rel="bookmark"><img src="{image_src|100x100}" alt="{image_alt}" class="tg-entry-image" /></a>
<h3 class="tg-entry-title"><a href="{permalink}" rel="bookmark">{post_title}</a></h3>
Posted on {post_date} by {post_author}.
<p>{post_category}</p></header>
<div class="tg-entry-content"><p>{post_excerpt}</p></div>
transition
Transition between loading the list of posts.
| accepted values | default | example shortcode |
|---|---|---|
| string | none | transition=fade |
static_taxonomy
Optionally filter also by terms of an additional taxonomy (not necessarily one of the taxonomies used for tag groups). Used together with static_terms.
| accepted values | default | example shortcode |
|---|---|---|
| string | none | static_taxonomy=category |
static_terms
Optionally filter also by terms of an additional taxonomy (not necessarily one of the taxonomies used for tag groups). Used together with static_taxonomy.
| accepted values | default | example shortcode |
|---|---|---|
| comma-separated list of integers | none | static_terms=42,255 |
Other
persistent_filter
The Dynamic Post Filter can optionally remember the selection of groups and tags so that your visitors who clicked on an article and then return to this page will see the same list of articles again. After loading, the page will scroll to the group selection menu. (Otherwise the browser might go to a random post, depending on the loading speed.)
The data is saved in a browser cookie. If you use several Dynamic Post Filters on your site, you should give each a different div_id so that each will have its own cookie.
The value is the time in minutes. Zero means off.
| accepted values | default | example shortcode |
| integer | 0 (off) | persistent_filter=30 |
Labels and Messages
placeholder
Placeholder message in the tag input field. It disappears as soon as you enter tags.
| accepted values | default | example shortcode |
|---|---|---|
| string | “Please enter your tags here.” | placeholder="" |
posts_placeholder
Placeholder message for the list of posts.
| accepted values | default | example shortcode |
|---|---|---|
| string | “Please select a group.” | posts_placeholder="" |
default_option_label
What the pull-down menu should show if no group is selected.
| accepted values | default | example shortcode |
|---|---|---|
| string | “Filter by group” | default_option_label="" |
groups_header
Header above the list of selected groups.
| accepted values | default | example shortcode |
|---|---|---|
| string | “Selected groups:” | groups_header="" |
message_only_existing
Error message if user tries to enter a tag that doesn’t exist.
| accepted values | default | example shortcode |
|---|---|---|
| string | 0 | message_only_existing="" |
message_same_group
Error message if user tries to enter a tag from another group.
| accepted values | default | example shortcode |
|---|---|---|
| string | 0 | message_same_group="" |
message_nothing_found
Message to show if no posts were found.
| accepted values | default | example shortcode |
|---|---|---|
| string | “Nothing found.” | message_nothing_found="" |
message_load_more
Label of the link to load more posts, if the pager is active.
| accepted values | default | example shortcode |
|---|---|---|
| string | “Load more” | message_load_more="" |
message_go_back
Label of the link to go back, if the pager is active.
| accepted values | default | example shortcode |
|---|---|---|
| string | “Go back” | message_go_back="" |
message_amount_singular
Message if one post was found, if display_amount is active.
| accepted values | default | example shortcode |
|---|---|---|
| string | “1 post found.” | message_amount_singular="One recipe found." |
message_amount_plural
Message if many posts were found, if display_amount is active. May contain the placeholder {count}
| accepted values | default | example shortcode |
|---|---|---|
| string | “{count} posts found.” | message_amount_plural="We found {count} recipes." |
Advanced Styling
You can set here classes to be referred to in CSS. You need some knowledge of CSS to use these options.
div_class
Define a class for the <div>.
| accepted values | default | example shortcode |
|---|---|---|
| string | empty | div_class=“change-pointer” |
article_class
Define a class for the enclosing <article>.
| accepted values | default | example shortcode |
|---|---|---|
| string | tg-post | article_class=“make-it-dark” |