Eric Teubert

<h4>Quick Start</h4>
<p>The plugin assumes your articles are well categorized.<br />
To display the archive, use the shortcode anywhere in a page or article.</p>
<pre><code>[archivist category="kitten"]
[archivist tag="kitten"]
</code></pre>
<p>Replace “kitten” with your category/tag. Watch out, we need the slug here.<br />
That’s the name without capital letters and spaces.</p>
<h4>Placeholders</h4>
<p>You can specify a custom template to display the archive elements.<br />
Go to <code>Settings > Archivist</code> for plugin preferences.<br />
Use HTML and any of the following template placeholders.</p>
<ul>
<li><code>%TITLE%</code> – The post title.</li>
<li><code>%PERMALINK%</code> – The post permalink.</li>
<li><code>%AUTHOR%</code> – The post author.</li>
<li><code>%CATEGORIES%</code> – The post categories as unordered list.</li>
<li><code>%CATEGORIES|...%</code> – The post categories with a custom separator. Example: <code>%CATEGORIES|, %</code></li>
<li><code>%TAGS%</code> – The post tags with default separator.</li>
<li><code>%TAGS|...%</code> – The post tags with a custom separator. Example: <code>%TAGS|, %</code></li>
<li><code>%EXCERPT%</code> – The post excerpt.</li>
<li><code>%POST_META|...%</code> – Any post meta. Example: <code>%POST_META|duration%</code>.</li>
<li><code>%POST_META|...|...%</code> – Any post meta list, separated by custom HTML. Example: <code>%POST_META|guest|<br>%</code></li>
<li><code>%DATE%</code> – The post date with default format.</li>
<li><code>%DATE|...%</code> – The post date with custom format. Example: <code>%DATE|Y/m/d%</code></li>
<li><code>%POST_THUMBNAIL|...x...%</code> – The post thumbnail with certain dimensions. Example: <code>%POST_THUMBNAIL|75x75%</code></li>
<li><code>%COMMENTS%</code> – The post comment count.</li>
<li><code>%ACF|field_name%</code> – Display <a href="https://www.advancedcustomfields.com" rel="nofollow ugc">ACF</a> field. Uses the <a href="https://www.advancedcustomfields.com/resources/get_field/" rel="nofollow ugc"><code>get_field()</code></a> function.</li>
</ul>
<p>You can add your own placeholders:</p>
<pre><code>add_filter( 'archivist_template_render', function( $template, $post ) {
    // modify $template
    return $template;
}, 10, 2 );
</code></pre>
<h4>Pagination</h4>
<p>If you have many entries, you may prefer to paginate. The archivist comes with asynchronous pagination built-in. Use the <code>pagination</code> parameter in the shortcode to activate it. Its value is the amount of items you want to display per page.</p>
<pre><code>[archivist category="kitten" pagination="10"]
</code></pre>
<p>Pagination controls are displayed both on top and at the bottom of the archive. You can customize this by setting <code>controls</code> to <code>top</code> or <code>bottom</code>.</p>
<pre><code>[archivist category="kitten" pagination="10" controls="top"]
</code></pre>
<h4>Filter by Query</h4>
<p>Are you feeling bold? Is filtering by category or archive not satisfying you? Read on, I’ve got a challenge for you.<br />
WordPress uses a certain query syntax to define the so called loop which is used to display the archive.<br />
You can find the complete documentation at https://codex.wordpress.org/Class_Reference/WP_Query<br />
and you can take advantage of every single parameter or combination of parameters listed there. Some examples:</p>
<pre><code>[archivist query="year=1984&author_name=gorwell"]
</code></pre>
<p>Lists all entries from the year <code>1984</code> by the author with <code>user_nicename</code> <code>gorwell</code>.</p>
<pre><code>[archivist query="tag=straw+mask&post_status=private&orderby=comment_count&order=DESC"]
</code></pre>
<p>Lists all entries marked with post status <code>private</code> which are tagged with both <code>straw</code> and <code>mask</code>, ordered by the amount of comments in a descending order.</p>
<h4>Using multiple Templates</h4>
<p>When you install the plugin, there is just one templated called “default”.<br />
If you don’t specify a specific template in the shortcode, this one will be used.<br />
Therefore the following two shortcodes yield identical results.</p>
<pre><code>[archivist category="kitten"]
[archivist category="kitten" template="default"]
</code></pre>
<p>You can add as many templates as you like. Think twice before deleting one. If it’s still in use, the archive can’t be displayed.</p>


Archivist – Custom Archive Templates

Shortcode Plugin to display an archive by category, tag or custom query. Customizable via HTML templates.

Scott Reilly

<p>This plugin provides thirteen handy template tags that relate to the index/position of a post within a loop’s listing of posts.</p>
<p>Some of the template tags provided by this plugin relate to the position of the current post within the current loop:</p>
<ul>
<li><code>c2c_is_first()</code></li>
<li><code>c2c_is_last()</code></li>
<li><code>c2c_is_at_index()</code></li>
<li><code>c2c_is_even()</code></li>
<li><code>c2c_is_odd()</code></li>
<li><code>c2c_get_the_index()</code></li>
<li><code>c2c_is_index_within()</code></li>
<li><code>c2c_the_index()</code></li>
</ul>
<p>Other functions help you get a post (or posts) at a given position in the current loop:</p>
<ul>
<li><code>c2c_get_post_by_index()</code></li>
<li><code>c2c_get_posts_by_index()</code></li>
</ul>
<p>While the remaining three functions relate to index information about the loop in general:</p>
<ul>
<li><code>c2c_get_last_index()</code></li>
<li><code>c2c_is_post_in_loop()</code></li>
<li><code>c2c_is_valid_index()</code></li>
</ul>
<p>Please see the Template Tags section (in some places found under the Other Notes section) for descriptions of all the functions and their arguments.</p>
<p>Note that index counting begins at 0, which means the first item has an index of 0. An index of -1 indicates no posts were found.</p>
<p>Links: <a href="https://coffee2code.com/wp-plugins/post-index-helpers/" rel="nofollow ugc">Plugin Homepage</a> | <a href="https://wordpress.org/plugins/post-index-helpers/" rel="ugc">Plugin Directory Page</a> | <a href="https://github.com/coffee2code/post-index-helpers/" rel="nofollow ugc">GitHub</a> | <a href="https://coffee2code.com" rel="nofollow ugc">Author Homepage</a></p>
<h3>Developer Documentation</h3>
<p>Developer documentation can be found in <a href="https://github.com/coffee2code/post-index-helpers/blob/master/DEVELOPER-DOCS.md" rel="nofollow ugc">DEVELOPER-DOCS.md</a>. That documentation covers the numerous template tags provided by the plugin.</p>
<p>As an overview, these are the template tags provided the plugin:</p>
<ul>
<li><code>c2c_get_last_index()</code>     : Gets the index number for the last post in the loop listing</li>
<li><code>c2c_get_post_by_index()</code>  : Get post based on specified index</li>
<li><code>c2c_get_posts_by_index()</code> : Get posts based on specified array of indexes</li>
<li><code>c2c_get_the_index()</code>      : Get the index for the current post</li>
<li><code>c2c_is_at_index()</code>        : Is the current index at the specified index?</li>
<li><code>c2c_is_even()</code>            : Is the current post at an even position? (i.e. 0, 2, 4, …)</li>
<li><code>c2c_is_first()</code>           : Is the current post the first listed post?</li>
<li><code>c2c_is_last()</code>            : Is the current post the last listed post?</li>
<li><code>c2c_is_odd()</code>             : Is the current post at an odd position? (i.e. 1, 3, 5, …)</li>
<li><code>c2c_is_index_within()</code>    : Is the current post (or one at the specified index) within the bounds of a specified range?</li>
<li><code>c2c_is_post_in_loop()</code>    : Is the specified post within the current loop?</li>
<li><code>c2c_is_valid_index()</code>     : Is the specified index valid?</li>
<li><code>c2c_the_index()</code>          : Echo the current post’s index</li>
</ul>


Post Index Helpers

A variety of template tags related to the index/position of a post within a loop's listing of posts.

Archivist – Custom Archive Templates vs Post Index Helpers