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 a function for use by developers who have their own code for fetching posts according to a given criteria and now want to make use of loop-aware template tags to display those posts.</p>
<p>WordPress’s template tags are intended to be used within ‘the loop’. The loop is managed by a WP_Query object which sets up various global variables and its own object variables for use by the various template tags. The primary purpose of a WP_Query object is to actually query the database for the posts that match the currently specified criteria. However, if you don’t need to query for posts since you already have them by some other means, you can still take advantage of the template tags by injecting those posts into the WP_Query via this plugin.</p>
<p>Depending on the template tags you are looking to use, or the logic you are hoping to employ within a loop, you may need to manually configure some of the query object’s variables.</p>
<p>Example:</p>
<pre><code><?php // Say we're in the sidebar

// We've gotten some post objects on our own.
$posts = c2c_get_random_posts( 5, '' );

// Inject the posts
c2c_inject_query_posts( $posts );

// Now let's display them via template tags:
if ( have_posts() ) :
    while ( have_posts() ) : the_post(); ?>

        <li><a href="<?php the_permalink() ?>" rel="bookmark" title="Permanent Link to <?php the_title_attribute(); ?>"><?php the_title(); ?></a></li>

    <?php endwhile;?>
<?php endif; ?>
</code></pre>
<p>Links: <a href="https://coffee2code.com/wp-plugins/inject-query-posts/" rel="nofollow ugc">Plugin Homepage</a> | <a href="https://wordpress.org/plugins/inject-query-posts/" rel="ugc">Plugin Directory Page</a> | <a href="https://github.com/coffee2code/inject-query-posts/" 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/inject-query-posts/blob/master/DEVELOPER-DOCS.md" rel="nofollow ugc">DEVELOPER-DOCS.md</a>. That documentation covers the template tag and hooks provided by the plugin.</p>
<p>As an overview, this is the template tag provided by the plugin:</p>
<ul>
<li><code>c2c_inject_query_posts()</code> : Template tag to inject an array of posts into a query object as if that query object had obtained those posts via a query.</li>
</ul>
<p>These are the hooks provided by the plugin:</p>
<ul>
<li><code>inject_query_posts_preserve_query_obj</code> : Overrides the value of the <code>$preserve_query_obj</code> argument passed to the function. This is not typical usage for most users.</li>
<li><code>c2c_inject_query_posts</code> : Allows use of an alternative approach to safely invoke <code>c2c_inject_query_posts()</code> in such a way that if the plugin were deactivated or deleted, then your calls to the function won’t cause errors in your site.</li>
</ul>


Inject Query Posts

Facilitates injecting an array of posts into a WP query object as if queried. Particularly useful to allow use of standard template tags.

Archivist – Custom Archive Templates vs Inject Query Posts