Automattic

Alex Mills

Nick Momrik

<p>Creates functions to assist in displaying a list of the most recent comments. Provides more configurability than the widget that comes with WordPress.</p>
<h3>Configuration</h3>
<p>You may pass parameters when calling the function to configure some of the options. Parameters are accepted only in the <a href="https://codex.wordpress.org/How_to_Pass_Tag_Parameters#Tags_with_query-string-style_parameters" rel="nofollow ugc">query-string-style</a>.</p>
<h4>list_most_recent_comments()</h4>
<p>In addition to the parameters that <a href="https://codex.wordpress.org/Function_Reference/get_comments" rel="nofollow ugc">get_comments()</a> and <code>get_most_recent_comments()</code> (see below) accept, this function accepts the following parameters:</p>
<ul>
<li><code>excerpt_words</code> — The number of words from the comment to display</li>
<li><code>excerpt_chars</code> — Or alternately the number of characters from the comment to display</li>
<li><code>comment_format</code> — Allows you to pick from two predefined display formats:</li>
</ul>
<ol>
<li><a href="#commentlink" rel="nofollow ugc">Comment Author</a> on <a href="#postlink" rel="nofollow ugc">Post Title</a></li>
<li><strong>Comment Author:</strong> <a href="#commentlink" rel="nofollow ugc">This is the comment excerpt</a></li>
</ol>
<p>Example:</p>
<pre><code><?php list_most_recent_comments( 'excerpt_words=5' ); ?>
</code></pre>
<h4>get_most_recent_comments()</h4>
<p>A more powerful version of <a href="https://codex.wordpress.org/Function_Reference/get_comments" rel="nofollow ugc">get_comments()</a>. It accepts the same parameters as well as the following ones:</p>
<ul>
<li><code>passworded_posts</code> — Boolean to control showing comments on passworded posts or not. Defaults to <code>false</code>.</li>
<li><code>showpings</code> — Boolean to control showing pings and trackbacks or not. Defaults to <code>false</code>.</li>
<li><code>post_types</code> — Array of post types to include comments from. Defaults to posts and pages: <code>array( 'post', 'page' )</code></li>
<li><code>post_statuses</code> — Array of post statuses to include comments from.  Defaults to published posts and static pages: <code>array( 'publish', 'static' )</code></li>
</ul>
<p>Arguments should likely be passed as an array instead of a string.</p>
<p>Example:</p>
<pre><code><?php

list_most_recent_comments( array(
    'showpings' => true,
    'post_types' => array( 'post', 'page', 'foobar' ),
) );

?>
</code></pre>


magicoders

Rafał Gicgier

<p>ACFRPW adds a new widget to the Appearance -> Widgets -> ACF Recent Posts Widget. Most of the fields are quite obvious, you can choose from a set of settings to display the posts from.<br />
Each setting alters the amount and type of posts listed in the sidebar.</p>
<span class="embed-youtube" style="text-align:center; display: block;"><iframe loading="lazy" class="youtube-player" width="750" height="422" src="https://www.youtube.com/embed/cv9BuKcfbhk?version=3&rel=1&showsearch=0&showinfo=1&iv_load_policy=1&fs=1&hl=en-US&autohide=2&wmode=transparent" allowfullscreen="true" style="border:0;" sandbox="allow-scripts allow-same-origin allow-popups allow-presentation allow-popups-to-escape-sandbox"></iframe></span>
<h4>Available Settings</h4>
<p>The widget supports the following settings:</p>
<ul>
<li>Widget Title</li>
<li>Custom Widget container CSS class</li>
<li>Option to ignore sticky posts</li>
<li>Search keyword query</li>
<li>Id based post exclusion</li>
<li>Date Display, Date Modified, Relative and Custom Date Format specifiaction</li>
<li>Listing posts from specific date period (start and end)</li>
<li>Listing posts with specific password, listing password protected posts only or excluding these</li>
<li>Post Type selection</li>
<li>Post Formats selection</li>
<li>Post Statuses selection</li>
<li>Listing posts limited to author via author id</li>
<li>Order specifiaction   (ASC or DESC)</li>
<li>Orderby specification (ID, Author, Title, Date, Modified, Random, Comment Count, Menu Order, Meta Value, Meta Value Numeric)</li>
<li>Meta Key specifiaction (if Meta Value or Meta Value Numeric were chosen as orderby rule)</li>
<li>Meta Comparison selection</li>
<li>Meta Value Specification (for the Meta Comparison selection)</li>
<li>Category limitation</li>
<li>Tag limitation</li>
<li>Id based custom taxonomy limitation</li>
<li>Operator specifiaction for the above rules</li>
<li>Number of posts to show</li>
<li>Number of posts to skip</li>
<li>Thumbnail display, thumbnail size (width, height), thumbnail alignment, default thumbnail</li>
<li>Excerpt display, its word limit, its readmore text (occurs only if the amount of words exceeds the limit)</li>
<li>Custom HTML to display before the loop</li>
<li>Custom HTML to display after the loop </li>
<li>Custom HTML to display before each posts. It supports custom meta keys and ACF fields</li>
<li>Custom HTML to display after each posts. It supports custom meta keys and ACF fields</li>
<li>Custom HTML to display for no posts found</li>
<li>Custom and default CSS</li>
<li>Custom HTML templates </li>
</ul>
<h4>ACF supported fields</h4>
<p>The plugin has been tested with ACF 6 (Free and Pro).</p>
<p>The plugin supports the following ACF fields:</p>
<ul>
<li>Text</li>
<li>Textarea</li>
<li>Number</li>
<li>Email</li>
<li>Password</li>
<li>Wysiwg Editor</li>
<li>Image</li>
<li>File</li>
</ul>
<p>No other fields have been tested and are supported at the moment.</p>
<h4>Shortcode</h4>
<p>From version 4.4 the plugin supports shortcode embeds. Given the amount of options and their specific names (as in shortcode attributes) the shorcode builder has been introduced<br />
see 7th and 8th screenshots for the reference.</p>
<p>You’ll see a popup once clicked on ACFRPW button which gives one an ability to automatically set up the shortcode code for you. The rest follows all of the options specified here.</p>
<p>To use the shortcode one needs to have the WordPress editor enabled for the current page / post type. In case it was disabled (say via ACF) the button won’t appear.</p>
<h4>Creating Custom Templates</h4>
<p>From version 4.3 the plugin supports custom templates. To make usage of these one needs to make a copy of all the files found<br />
in the acf-recent-posts-widget/templates directory and copy them over to the active template directory to acfrpw subdirectory.<br />
The approach is similar to the way WooCommerce plugin works and has it’s drawbacks. With every new feature the files may be outdated.</p>
<p>Similarly to the widget template files, a separate, custom markup can be created for the shortcode build post listing. Copy the acf-recent-posts-widget/template files<br />
to acfrpw-blog directory created inside your active theme directory.</p>
<h4>Template files</h4>
<p>There are 3 main template files:</p>
<ul>
<li>loop-after.php (which displays the markup after each of the posts and closes the markup container)</li>
<li>loop-before.php (which displays the markup before each of the posts and opens the markup container)</li>
<li>loop-inner.php (which is enqueued for each of the posts separatelly and contains the markup of every single post)</li>
</ul>
<h4>Usage</h4>
<p>The usage is quite advanced hence each template file contains a quite detailed documentation on how to use it.</p>
<p>First of all the template files mustn’t have the global variables removed. Each of these variables stores the widget settings, which are then used to generate the code.<br />
Second of all the variable names are unobvious, loop-inner.php template file contains a list of all the names used, which are then extracted and available as php variables.</p>
<h4>Different template per widget / sidebar</h4>
<p>The templates allow one to adjust the markup of each single widget. One needs first to verify the widget id used, which may then be referenced.<br />
The variable which stores the widget id is $acf_rpw_args[‘widget_id’]. Dumping the value in the template is the best way to find out which automatic id has been created for your widget.</p>
<p>The best way to handle the templates is to learn from their code. My personal suggestion is to copy over the templates to the current theme and work directly on them, doing one change at a time.<br />
The templates require learning curve to use and there’s no single answer to everyones problem.</p>
<h4>Complex usage</h4>
<p>This section covers plugin complex usage for advanced user willing to have more control over the behavior of the plugin as well as explains uncommon functionalities.</p>
<h4>Using the HTML textarea fields</h4>
<p>These sections might not be obvious. The HTML or text before / after the whole loop setting is an area where you can specify custom HTML markup to be added before / after the whole posts list.<br />
The HTML or text before / after each post is an area where you can not only specify custom HTML, but you are also given an ability to print any meta key or certain ACF fields (see <a href="#acf-support" rel="nofollow ugc">ACF supported fields</a>)</p>
<h4>Meta Key Name / ACF Usage</h4>
<p>These fields need to be wrapped inside the {meta name} or {acf field_name} tags (which are similar to shortcodes). The plugin will then parse these fields and print their according value. Say we have a custom ACF field of type text, for which the Field Name is “text”.<br />
To print its value one has to use [acf text] inside the befoe / after each post textarea. A similar solution applies to the meta key.</p>
<h4>Meta Value Usage</h4>
<p>The Meta Value field supports an array of elements, so that all of the meta_compare parameters could be used. To do so, please specify the two parameters separated by semicolon, for instance: 1234;12345.<br />
The plugin will convert these into an array and apply the proper operation for the two. Whatsmore the [date] shortcode can be used here. It takes the timestamp paramater as an argument, which is required – the possible arguments are the same as for<br />
the function described here: http://php.net/manual/pl/function.strtotime.php. For instance [date +1 day] would generate the tomorrow date in “Ymd” format.<br />
This can be used with custom meta field date.</p>
<h4>Plugin Filters</h4>
<p>The are several filters that can be used to enchance the plugin programatically:</p>
<ul>
<li>‘acf_rwp_query’ which gives one the ability to filter the query applied to each widget. </li>
<li>‘acp_rwp_before’ which gives on the ability to filter the Front End output of the plugin before each post. There are two hooks attached here already which allow usage of the [acf] and [meta] shortcodes.</li>
<li>‘acp_rwp_after’ which gives on the ability to filter the Front End output of the plugin after each post. There are two hooks attached here already which allow usage of the [acf] and [meta] shortcodes.</li>
<li>‘acf_meta_value’ which filters the meta_value query parameter. </li>
</ul>
<p>Check the acf_widget_widget file for the arguments and use cases.</p>
<h3>Dependencies</h3>
<ul>
<li><a href="http://www.advancedcustomfields.com/" rel="nofollow ugc">ACF</a> (optional)</li>
<li><a href="https://github.com/gicolek/Widget-Base-Class" rel="nofollow ugc">Widget Base Class</a> (included)</li>
<li><a href="https://github.com/gicolek/shortcode-popups" rel="nofollow ugc">Shortcode popups generator</a> (included)</li>
</ul>
<h4>Other</h4>
<ul>
<li><a href="http://acfrpw-demo.wp-doin.com/" rel="nofollow ugc">Online Demo</a> </li>
<li><a href="http://wp-doin.com/portfolio/acfrpw/" rel="nofollow ugc">Plugin site and Docs</a></li>
<li><a href="http://wp-doin.com/2015/10/21/acf-recent-posts-widget-survey/" rel="nofollow ugc">Plugin Development Survey</a></li>
</ul>
<h4>Languages Supported</h4>
<ul>
<li>English (default)</li>
<li>Polish (since May 11 2015)</li>
<li>French (since June 29 2015), by <a href="https://wordpress.org/support/profile/wolforg" rel="ugc">wolforg</a>, <a href="http://www.wptrads.com/extension/acf-recent-posts-widget/" rel="nofollow ugc">standalone source</a></li>
<li>Spanish (since July 30 2023)</li>
</ul>


ACF Recent Posts Widget

ACF Recent Posts Widget (ACFRPW) is a WordPress plugin which adds a custom, extended Recent Posts Widget - with ACF and Meta Keys support

Recent Comments vs ACF Recent Posts Widget