shazdeh

Peter Hebert

<p>This plugin gives you <code>[query]</code> shortcode which enables you to query and output any posts filtered by specific attributes.</p>
<h4>Usage</h4>
<p>You can use most parameters supported by <a href="https://codex.wordpress.org/Class_Reference/WP_Query" rel="nofollow ugc">WP_Query class</a> to filter the posts; you can query for specific post types, categories, tags, authors, etc.</p>
<h4>Other supported parameters</h4>
<p>Aside from WP_Query parameters, the shortcode also supports the following additional parameters:</p>
<ul>
<li><em>featured</em>: to query for sticky posts which by default are excluded from the query.</li>
<li><em>thumbnail_size</em>: to specify the size of the {THUMBNAIL} images. You can use <a href="https://codex.wordpress.org/Function_Reference/add_image_size#Reserved_Image_Size_Names" rel="nofollow ugc">built-in image sizes</a> or custom ones you’ve defined.</li>
<li><em>content_limit</em>: to limit the number of words of the {CONTENT} var; by default it’s “0” which means it outputs the whole content.</li>
<li><em>posts_separator</em>: text to display between individual posts.</li>
<li><em>lens</em>: custom output template – see description below.</li>
<li><em>twig_template</em>: output template using Twig templating engine – requires the Timber library.</li>
</ul>
<h4>Formatting the output</h4>
<p>You can define how you want to format the output inline within an opening <code>[query]</code> and closing <code>[/query]</code> tag.<br />
Available keywords are: TITLE, CONTENT, AUTHOR, AUTHOR_URL, DATE, THUMBNAIL, CONTENT, COMMENT_COUNT.</p>
<p>The following example will display the latest 5 posts from the category with the ID of 3, showing a post title and comment count, with a link to the post:<br />
    [query posts_per_page=”5″ cat=”3″]</p>
<h3><a href="{URL}" rel="nofollow ugc">{TITLE} ({COMMENT_COUNT})</a></h3>
<p>[/query]</p>
<p>Grid display</p>
<p>With the “cols” parameter you can display the output in a grid.<br />
    [query posts_per_page=”3″ cols=”3″] {THUMBNAIL}</p>
<h3>{TITLE}</h3>
<p>{CONTENT} [/query]<br />
will display the latest 3 posts in the defined template, in 3 columns.<br />
The plugin will automatically divide the grid into rows based upon the ‘posts_per_page’ option, divided by the ‘cols’ option.</p>
<h4>Lenses (output templates)</h4>
<p>With the “lens” parameter you can customize the display of the query results using a template. Some basic lenses/templates are provided:</p>
<ul>
<li><strong>ul</strong>: unordered list of linked post titles.</li>
<li><strong>ul-title-date</strong>: same as ‘ul’, but also displays the posted date.</li>
<li><strong>article-excerpt</strong>: series of articles, with a header containing the linked post title, and the excerpt.</li>
<li><strong>article-excerpt-date</strong>: same as ‘article-excerpt’, but also displays the posted date.</li>
<li><strong>cards</strong>: displays the post thumb above the header with linked post title, followed by the excerpt.</li>
</ul>
<p>Bootstrap lenses</p>
<p>Some pre-defined lenses/templates are provided which use JavaScript Components from the <a href="http://getbootstrap.com/" rel="nofollow ugc">Bootstrap</a> CSS framework. The generated markup is compliant with the 5.x version of Bootstrap.</p>
<p>This feature relies on Bootstrap library to be already loaded on the page, the plugin does <em>not</em> include it.</p>
<p>If you’re using a Bootstrap-based theme, this <em>should</em> work; otherwise you can use the <a href="https://wordpress.org/extend/plugins/bootstrap/" rel="ugc">Bootstrap plugin</a>).</p>
<p><a href="http://getbootstrap.com/javascript/#tabs" rel="nofollow ugc">Tabs</a></p>
<p>This will show the latest 3 posts in a tabbed widget.<br />
    [query posts_per_page=”3″ lens=”tabs”]</p>
<p><a href="http://getbootstrap.com/javascript/#tabs" rel="nofollow ugc">Accordion</a></p>
<p>This will create an accordion widget of all our posts from the “faq” post type.<br />
    [query posts_per_page=”0″ post_type=”faq” lens=”accordion”]</p>
<p><a href="http://getbootstrap.com/javascript/#carousel" rel="nofollow ugc">Carousel</a></p>
<p>This creates a carousel of latest five featured posts:<br />
    [query posts_per_page=”5″ featured=”true” lens=”carousel”]</p>
<p>Custom Lenses/templates</p>
<p>You can create your own custom templates and put them into one of these pre-defined folder names within your theme:</p>
<ul>
<li>‘query-shortcode-templates’</li>
<li>‘partials/query-shortcode-lenses/’</li>
<li>‘html/lenses/’</li>
</ul>
<p>Or simply specify your own subfolder in the ‘lens’ parameter:<br />
    [query lens=”folder/template-name”]</p>
<h4>Twig Template Support</h4>
<p>Starting with version 0.4, you can use Twig templates for your output. Support for Twig is provided by the <a href="https://github.com/timber/timber" rel="nofollow ugc">Timber</a> library.</p>
<p>This requires that Timber 2.x be installed as a <a href="https://timber.github.io/docs/v2/installation/installation/" rel="nofollow ugc">Composer dependency</a>.</p>
<p>To use a Twig template for your query output, simply use the 'twig_template' parameter instead of the 'lens' parameter, and provide the path to your template. By default, Timber looks within the <code>views</code> folder in your active theme. You can <a href="https://timber.github.io/docs/v2/guides/template-locations/#changing-the-default-folder-for-twig-files" rel="nofollow ugc">change the default template location</a> in Timber.</p>
<p>Examples:</p>
<pre><code>[query twig_template="template-name.twig"]
[query twig_template="folder/template-name.twig"]
</code></pre>


Custom Query Shortcode

A powerful shortcode that enables you to query anything you want and display it however you like, on both pages and posts, and in widgets.

john ackers

<p>Presents the results a database SQL query in a table. The query can be saved as a<br />
named view which can then be embedded as a table in any post using the shortcode<br />
[dbview name=name-of-view]. Views can be created and edited in the dashboard.</p>
<h4>Shortcode examples</h4>
<p>Show the ‘world cities’ view with a page size of 50 rows.<br />
    [dbview name=’world cities’ pagesize=50]</p>
<p>Show the ‘world cities’ view initially sorted by column ‘city’ in ascending order.<br />
    [dbview name=’world cities’ sort=city order=asc]</p>
<p>Show the ‘world cities’ view initially sorted by column ‘population’ in descending order.<br />
    [dbview name=’world cities’ sort=population order=desc]</p>
<p>Show the ‘world cities’ view without any pagination.<br />
    [dbview name=’world cities’]</p>
<p>Show the ‘world cities’ in the US with a population of greater than 5 million. See FAQ on passing arguments.<br />
    [dbview name=’world cities in country’ sort=city order=asc pagesize=10<br />
     arg1=’United States’ arg2=5000000]</p>
<h4>End User Features</h4>
<ul>
<li>Column sorting on table header. Columns are enabled on each column.</li>
<li>Page navigation is on the table footer (from 0.5.3).  </li>
<li>Tables are loaded using AJAX.</li>
</ul>
<h4>Management Features</h4>
<ul>
<li>Each view can be created/edited/deleted and tested under dbview/Settings in the dashboard.</li>
<li>Easy view consists of one SQL statement plus an optional PHP snippet associated wthe each column.</li>
<li>Sorting on each column can be enabled and disabled.</li>
<li>Each column can be manipulated using a PHP snippet. This functionality allows the introduction of permalinks, images and other customisations. </li>
<li>Each view is stored in a single serialized object in the wp_options table.</li>
</ul>
<h4>Limitations</h4>
<ul>
<li>Tables are not styled; this is left to the theme. </li>
<li>The data in the results table(s) cannot be edited.</li>
</ul>
<h4>Security</h4>
<p>When the plugin is activated, administrators are given the capability to ‘manage DB views’.<br />
Any other wp user with a different role that needs to create/edit views <a href="https://codex.wordpress.org/Roles_and_Capabilities" rel="nofollow ugc">must be granted that capability</a>.<br />
Only a view that is explicitly checked as public will be visible to non administrators and the public.</p>


dbview

Presents the results a database SQL query in a table. The query can be saved as a

Custom Query Shortcode vs dbview