{"id":14907,"date":"2011-09-15T07:00:54","date_gmt":"2011-09-15T07:00:54","guid":{"rendered":"https:\/\/wordpress.org\/plugins-wp\/archivist-custom-archive-templates\/"},"modified":"2024-02-23T12:50:01","modified_gmt":"2024-02-23T12:50:01","slug":"archivist-custom-archive-templates","status":"closed","type":"plugin","link":"https:\/\/wordpress.org\/plugins\/archivist-custom-archive-templates\/","author":6679869,"comment_status":"closed","ping_status":"closed","template":"","meta":{"version":"1.7.7","stable_tag":"1.7.7","tested":"6.1.10","requires":"3.0","requires_php":"","requires_plugins":null,"header_name":"Archivist - Custom Archive Templates","header_author":"Eric Teubert","header_description":"","assets_banners_color":"f2f2f2","last_updated":"2024-02-23 12:50:01","external_support_url":"","external_repository_url":"","donate_link":"http:\/\/flattr.com\/thing\/396382\/WordPress-Plugin-Archivist-Custom-Archive-Templates","header_plugin_uri":"https:\/\/wordpress.org\/plugins\/archivist-custom-archive-templates\/","header_author_uri":"http:\/\/eric@ericteubert.de","rating":4.7,"author_block_rating":0,"active_installs":600,"downloads":25213,"num_ratings":10,"support_threads":0,"support_threads_resolved":0,"author_block_count":0,"sections":["description","installation","changelog"],"tags":{"1.0.0":{"tag":"1.0.0","author":"eteubert","date":"2011-09-15 13:35:47"},"1.1.0":{"tag":"1.1.0","author":"eteubert","date":"2011-09-15 13:34:26"},"1.2.0":{"tag":"1.2.0","author":"eteubert","date":"2011-09-16 14:14:07"},"1.2.1":{"tag":"1.2.1","author":"eteubert","date":"2011-09-16 14:53:39"},"1.2.2":{"tag":"1.2.2","author":"eteubert","date":"2011-09-18 12:34:32"},"1.2.3":{"tag":"1.2.3","author":"eteubert","date":"2011-09-18 12:50:05"},"1.3.0":{"tag":"1.3.0","author":"eteubert","date":"2011-09-19 17:15:22"},"1.3.1":{"tag":"1.3.1","author":"eteubert","date":"2011-09-19 18:34:59"},"1.3.2":{"tag":"1.3.2","author":"eteubert","date":"2011-09-21 09:09:17"},"1.3.3":{"tag":"1.3.3","author":"eteubert","date":"2011-09-21 13:18:42"},"1.3.4":{"tag":"1.3.4","author":"eteubert","date":"2011-10-03 14:32:54"},"1.3.5":{"tag":"1.3.5","author":"eteubert","date":"2011-10-03 16:33:17"},"1.3.6":{"tag":"1.3.6","author":"eteubert","date":"2011-11-09 07:12:12"},"1.3.7":{"tag":"1.3.7","author":"eteubert","date":"2011-11-09 11:12:34"},"1.3.8":{"tag":"1.3.8","author":"eteubert","date":"2012-01-02 16:28:07"},"1.4":{"tag":"1.4","author":"eteubert","date":"2012-01-28 11:13:26"},"1.4.1":{"tag":"1.4.1","author":"eteubert","date":"2012-01-31 13:11:11"},"1.4.2":{"tag":"1.4.2","author":"eteubert","date":"2012-12-21 11:56:04"},"1.4.3":{"tag":"1.4.3","author":"eteubert","date":"2012-12-21 11:59:43"},"1.5.1":{"tag":"1.5.1","author":"eteubert","date":"2012-12-21 12:27:53"},"1.6":{"tag":"1.6","author":"eteubert","date":"2015-03-01 12:18:49"},"1.7":{"tag":"1.7","author":"eteubert","date":"2017-01-06 09:24:26"},"1.7.1":{"tag":"1.7.1","author":"eteubert","date":"2017-01-06 15:07:53"},"1.7.2":{"tag":"1.7.2","author":"eteubert","date":"2017-01-06 15:16:41"},"1.7.3":{"tag":"1.7.3","author":"eteubert","date":"2017-01-07 17:42:53"},"1.7.4":{"tag":"1.7.4","author":"eteubert","date":"2018-01-02 14:08:01"},"1.7.6":{"tag":"1.7.6","author":"eteubert","date":"2023-02-14 21:52:04"},"1.7.7":{"tag":"1.7.7","author":"eteubert","date":"2024-02-23 12:50:01"}},"upgrade_notice":{"0.9 to 1.0":"<ul>\n<li>change your shortcodes to [archivist ...]<\/li>\n<\/ul>"},"ratings":{"1":0,"2":"1","3":0,"4":0,"5":"9"},"assets_icons":{"icon-128x128.png":{"filename":"icon-128x128.png","revision":1569363,"resolution":"128x128","location":"assets","locale":""}},"assets_banners":{"banner-772x250.png":{"filename":"banner-772x250.png","revision":483465,"resolution":"772x250","location":"assets","locale":""}},"assets_blueprints":{},"all_blocks":[],"tagged_versions":["1.0.0","1.1.0","1.2.0","1.2.1","1.2.2","1.2.3","1.3.0","1.3.1","1.3.2","1.3.3","1.3.4","1.3.5","1.3.6","1.3.7","1.3.8","1.4","1.4.1","1.4.2","1.4.3","1.5.1","1.6","1.7","1.7.1","1.7.2","1.7.3","1.7.4","1.7.6","1.7.7"],"block_files":[],"assets_screenshots":{"screenshot-1.png":{"filename":"screenshot-1.png","revision":1102477,"resolution":"1","location":"assets","locale":""},"screenshot-2.png":{"filename":"screenshot-2.png","revision":1102477,"resolution":"2","location":"assets","locale":""}},"screenshots":{"1":"The Admin Interface","2":"Example Archive"}},"plugin_section":[],"plugin_tags":[1445,89,526,80,90],"plugin_category":[43,57],"plugin_contributors":[82056],"plugin_business_model":[],"class_list":["post-14907","plugin","type-plugin","status-closed","hentry","plugin_tags-archive","plugin_tags-category","plugin_tags-loop","plugin_tags-shortcode","plugin_tags-tag","plugin_category-customization","plugin_category-taxonomy","plugin_contributors-eteubert","plugin_committers-eteubert"],"banners":[],"icons":{"svg":false,"icon":"https:\/\/s.w.org\/plugins\/geopattern-icon\/archivist-custom-archive-templates_f2f2f2.svg","icon_2x":false,"generated":true},"screenshots":[{"src":"https:\/\/ps.w.org\/archivist-custom-archive-templates\/assets\/screenshot-1.png?rev=1102477","caption":"The Admin Interface"},{"src":"https:\/\/ps.w.org\/archivist-custom-archive-templates\/assets\/screenshot-2.png?rev=1102477","caption":"Example Archive"}],"raw_content":"<!--section=description-->\n<h4>Quick Start<\/h4>\n\n<p>The plugin assumes your articles are well categorized.\nTo display the archive, use the shortcode anywhere in a page or article.<\/p>\n\n<pre><code>[archivist category=\"kitten\"]\n[archivist tag=\"kitten\"]\n<\/code><\/pre>\n\n<p>Replace \"kitten\" with your category\/tag. Watch out, we need the slug here.\nThat's the name without capital letters and spaces.<\/p>\n\n<h4>Placeholders<\/h4>\n\n<p>You can specify a custom template to display the archive elements.\nGo to <code>Settings &gt; Archivist<\/code> for plugin preferences.\nUse HTML and any of the following template placeholders.<\/p>\n\n<ul>\n<li><code>%TITLE%<\/code> - The post title.<\/li>\n<li><code>%PERMALINK%<\/code> - The post permalink.<\/li>\n<li><code>%AUTHOR%<\/code> - The post author.<\/li>\n<li><code>%CATEGORIES%<\/code> - The post categories as unordered list.<\/li>\n<li><code>%CATEGORIES|...%<\/code> - The post categories with a custom separator. Example: <code>%CATEGORIES|, %<\/code><\/li>\n<li><code>%TAGS%<\/code> - The post tags with default separator.<\/li>\n<li><code>%TAGS|...%<\/code> - The post tags with a custom separator. Example: <code>%TAGS|, %<\/code><\/li>\n<li><code>%EXCERPT%<\/code> - The post excerpt.<\/li>\n<li><code>%POST_META|...%<\/code> - Any post meta. Example: <code>%POST_META|duration%<\/code>.<\/li>\n<li><code>%POST_META|...|...%<\/code> - Any post meta list, separated by custom HTML. Example: <code>%POST_META|guest|&lt;br&gt;%<\/code><\/li>\n<li><code>%DATE%<\/code> - The post date with default format.<\/li>\n<li><code>%DATE|...%<\/code> - The post date with custom format. Example: <code>%DATE|Y\/m\/d%<\/code><\/li>\n<li><code>%POST_THUMBNAIL|...x...%<\/code> - The post thumbnail with certain dimensions. Example: <code>%POST_THUMBNAIL|75x75%<\/code><\/li>\n<li><code>%COMMENTS%<\/code> - The post comment count.<\/li>\n<li><code>%ACF|field_name%<\/code> - Display <a href=\"https:\/\/www.advancedcustomfields.com\">ACF<\/a> field. Uses the <a href=\"https:\/\/www.advancedcustomfields.com\/resources\/get_field\/\"><code>get_field()<\/code><\/a> function.<\/li>\n<\/ul>\n\n<p>You can add your own placeholders:<\/p>\n\n<pre><code>add_filter( 'archivist_template_render', function( $template, $post ) {\n    \/\/ modify $template\n    return $template;\n}, 10, 2 );\n<\/code><\/pre>\n\n<h4>Pagination<\/h4>\n\n<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>\n\n<pre><code>[archivist category=\"kitten\" pagination=\"10\"]\n<\/code><\/pre>\n\n<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>\n\n<pre><code>[archivist category=\"kitten\" pagination=\"10\" controls=\"top\"]\n<\/code><\/pre>\n\n<h4>Filter by Query<\/h4>\n\n<p>Are you feeling bold? Is filtering by category or archive not satisfying you? Read on, I've got a challenge for you.\nWordPress uses a certain query syntax to define the so called loop which is used to display the archive.\nYou can find the complete documentation at http:\/\/codex.wordpress.org\/Class_Reference\/WP_Query\nand you can take advantage of every single parameter or combination of parameters listed there. Some examples:<\/p>\n\n<pre><code>[archivist query=\"year=1984&amp;author_name=gorwell\"]\n<\/code><\/pre>\n\n<p>Lists all entries from the year <code>1984<\/code> by the author with <code>user_nicename<\/code> <code>gorwell<\/code>.<\/p>\n\n<pre><code>[archivist query=\"tag=straw+mask&amp;post_status=private&amp;orderby=comment_count&amp;order=DESC\"]\n<\/code><\/pre>\n\n<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>\n\n<h4>Using multiple Templates<\/h4>\n\n<p>When you install the plugin, there is just one templated called \"default\".\nIf you don't specify a specific template in the shortcode, this one will be used.\nTherefore the following two shortcodes yield identical results.<\/p>\n\n<pre><code>[archivist category=\"kitten\"]\n[archivist category=\"kitten\" template=\"default\"]\n<\/code><\/pre>\n\n<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>\n\n<!--section=installation-->\n<ol>\n<li>Upload the <code>archivist<\/code> directory to the <code>\/wp-content\/plugins\/<\/code> directory<\/li>\n<li>Activate the plugin through the 'Plugins' menu in WordPress<\/li>\n<li>Place <code>[archivist category=\"kitten\"]<\/code> in your archive post or page<\/li>\n<\/ol>\n\n<!--section=changelog-->\n<h4>1.7.7<\/h4>\n\n<ul>\n<li>fix security issues (XSS)<\/li>\n<\/ul>\n\n<h4>1.7.5<\/h4>\n\n<ul>\n<li>fix PHP 8 compatibility<\/li>\n<li>fix security issues<\/li>\n<\/ul>\n\n<h4>1.7.4<\/h4>\n\n<ul>\n<li>add Chinese language files<\/li>\n<\/ul>\n\n<h4>1.7.3<\/h4>\n\n<ul>\n<li>fix use of PHP 5.4 syntax<\/li>\n<\/ul>\n\n<h4>1.7.2<\/h4>\n\n<ul>\n<li>fix: define own ajaxurl in case the global one is not defined<\/li>\n<\/ul>\n\n<h4>1.7.1<\/h4>\n\n<ul>\n<li>fix: set jQuery as dependency<\/li>\n<\/ul>\n\n<h4>1.7<\/h4>\n\n<ul>\n<li>New Feature: Pagination. Use <code>pagination=\"10\"<\/code> as shortcode parameter to paginate your archive with 10 items per page. See readme for more details.<\/li>\n<li>New Feature: Support for ACF Fields. <code>%ACF|field_name%<\/code> - Display <a href=\"https:\/\/www.advancedcustomfields.com\">ACF<\/a> field. Uses the <a href=\"https:\/\/www.advancedcustomfields.com\/resources\/get_field\/\"><code>get_field()<\/code><\/a> function.<\/li>\n<\/ul>\n\n<p>This update is sponsored by <a href=\"http:\/\/lightaware.org\/\">Light Aware<\/a>.<\/p>\n\n<h4>1.6<\/h4>\n\n<ul>\n<li>Enhancement: Use Ace editor with HTML and CSS syntax highlighting<\/li>\n<li>Fix: PHP warnings<\/li>\n<li>Fix: Some links in about box<\/li>\n<\/ul>\n\n<h4>1.5.1<\/h4>\n\n<ul>\n<li>Hotfix: Typo, sorry<\/li>\n<\/ul>\n\n<h4>1.5<\/h4>\n\n<ul>\n<li>Enhancement: display_by_query: default to displaying all posts (like tag and category display)<\/li>\n<li>Feature: enable shortcodes in templates<\/li>\n<\/ul>\n\n<h4>1.4.1<\/h4>\n\n<ul>\n<li>hotfix: forgot to deploy a new file to svn<\/li>\n<\/ul>\n\n<h4>1.4<\/h4>\n\n<ul>\n<li>restore PHP 5.2 backwards compatibility<\/li>\n<\/ul>\n\n<h4>1.3.8<\/h4>\n\n<ul>\n<li>fix default thumb bug<\/li>\n<li>add support for post meta lists<\/li>\n<li>add plugin repo banner<\/li>\n<\/ul>\n\n<h4>1.3.7<\/h4>\n\n<ul>\n<li>fix typo (prevented custom css from being used)<\/li>\n<\/ul>\n\n<h4>1.3.6<\/h4>\n\n<ul>\n<li>fix bug using query parameter in shortcode<\/li>\n<\/ul>\n\n<h4>1.3.4 &amp; 1.3.5<\/h4>\n\n<ul>\n<li>minor capability fix<\/li>\n<\/ul>\n\n<h4>1.3.3<\/h4>\n\n<ul>\n<li>generic backslash fix<\/li>\n<\/ul>\n\n<h4>1.3.2<\/h4>\n\n<ul>\n<li>you can now set any template as the default<\/li>\n<li>current default template more easily recognizable (bold font &amp; marked in template chooser)<\/li>\n<li>add internal version number so update and compatibility scripts get run only when needed<\/li>\n<li>Bugfixes (Settings Validation, backslashes, ...)<\/li>\n<\/ul>\n\n<h4>1.3.1<\/h4>\n\n<ul>\n<li>fix backward compatibility issue<\/li>\n<\/ul>\n\n<h4>1.3.0<\/h4>\n\n<ul>\n<li>templates can be renamed<\/li>\n<li>\"default\" template can be renamed, too<\/li>\n<li>when you delete the last template, the \"edit template\" tab is deactivated until you create a new one<\/li>\n<li>some bug fixes<\/li>\n<\/ul>\n\n<h4>1.2.2, 1.2.3<\/h4>\n\n<ul>\n<li>Hotfixes<\/li>\n<\/ul>\n\n<h4>1.2.1<\/h4>\n\n<ul>\n<li>add missing textdomains<\/li>\n<\/ul>\n\n<h4>1.2.0<\/h4>\n\n<ul>\n<li>allow for multiple templates<\/li>\n<li>add an examples block in the sidebar<\/li>\n<\/ul>\n\n<h4>1.1.0<\/h4>\n\n<ul>\n<li>add fallback thumbnail<\/li>\n<li>new options page<\/li>\n<\/ul>\n\n<h4>1.0.1<\/h4>\n\n<ul>\n<li>fix typos<\/li>\n<\/ul>\n\n<h4>1.0<\/h4>\n\n<ul>\n<li>change name to Archivist - \"Custom Archive Templates\"<\/li>\n<li>change shortcode<\/li>\n<\/ul>\n\n<h4>0.9<\/h4>\n\n<ul>\n<li>It's alive!<\/li>\n<\/ul>","raw_excerpt":"Shortcode Plugin to display an archive by category, tag or custom query. Customizable via HTML templates.","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin\/14907","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin"}],"about":[{"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/types\/plugin"}],"replies":[{"embeddable":true,"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/comments?post=14907"}],"author":[{"embeddable":true,"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wporg\/v1\/users\/eteubert"}],"wp:attachment":[{"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/media?parent=14907"}],"wp:term":[{"taxonomy":"plugin_section","embeddable":true,"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_section?post=14907"},{"taxonomy":"plugin_tags","embeddable":true,"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_tags?post=14907"},{"taxonomy":"plugin_category","embeddable":true,"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_category?post=14907"},{"taxonomy":"plugin_contributors","embeddable":true,"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_contributors?post=14907"},{"taxonomy":"plugin_business_model","embeddable":true,"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_business_model?post=14907"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}