danielpataki

Unread posts is a plugin for regular users and developers alike. For regular users it allows for the creation of widgets that display posts the user has not yet read. It will work for logged in and logged out users as well. You can also add unread posts just below your single post content.
For logged out users the plugin uses cookies so please make sure your users consent to cookies by using a plugin like <a href="https://wordpress.org/plugins/cookie-law-info/screenshots/" rel="ugc">Cookie Law Info</a>.
The plugin contains a bunch of developer friendly features so you can easily leverage the core functionality, the management of read/unread posts. The class may be used alone, you can use some built in functions and I’ve added a bunch of filters for you to modify everything from what shows up in lists to how the lists are actually displayed.
For more information on developer features take a look at the Other Notes section.
<h4>Usage</h4>
The plugin offers a widget and an optional section below posts. The widget can be added in Appearance->Widgets and has a number of options. Hopefully these are all self explanatory, let me know if you have any questions.
There is also a settings section under Settings->Unread Posts. This page contains settings for the unread posts section to be placed under posts. You can enable this section by ticking the “Show Below Post Content?” box. The options are much the same as the widgets but you have a bit more control over when and what is shown.
First of all, use “Show Below Post Types” setting to set where this section shows up at all. The unread posts section will only show up under posts with the set post type(s).
The “Post Types To List” section allows you to control which post types are shown in the list. If “Same as the current post” is selected the post types listed will match the post type shown. Ie: On pages only pages will be shown, on posts only posts will be shown.
If you select “Select from a list” you will get a dropdown which allows you to specify the post types you would like shown in the list.
<h4>Thanks</h4>
<ul>
<li><a href="fontawesome.io" rel="nofollow ugc">FontAwesome</a> for the icons used in the plugin featured image and icon 
The plugin was written in a completely object oriented fashion to make it easy to extend. If you need to use the raw functionality of unread posts you’ll want to use the $up_unread_posts variable which can be globalized and used anywhere.</li>
</ul>
<h4>Using The Unread Posts Class</h4>
This has the following methods you can use:
<ul>
<li>set_posts_as_read( $posts )</li>
<li>set_posts_as_unread( $posts )</li>
<li>get_read_posts()</li>
<li>get_unread_posts()</li>
<li>delete_read_posts()</li>
</ul>
Please see the appropriate files for more information on these functions and how to use them. All files have extensive phpDoc which should help you out.
Depending on the user state different classes handle these functions, you can also create your own handler. Each handler must adhere to the UP_Unread_Posts_Handler_Interface interface.
Also note that some functions may not be usable everywhere. For example, cookies are used to store read posts. The value of cookies must be set before any HTML is sent so you can’t just use the set_posts_as_read() function anywhere you’d like.
<h4>Hooks</h4>
The plugin has lots of hooks which help you extend it. Here is a full list of the ones available right now:
up/cookie_name 
The default cookie name used will be ‘[blog-name]-up_read_posts’. If you’d like to change it you can use this filter. The only parameter it receives is the cookie name.
<pre><code>add_filter( 'up/cookie_name', 'my_up_cookie_name' );
function my_up_cookie_name() {
 return 'my-awesome-up-cookie';
}
</code></pre>
up/meta_field 
The default user meta key used will be ‘up_read_posts’. If you’d like to change it you can use this filter. The only parameter it receives is the meta key name.
<pre><code>add_filter( 'up/meta_field', 'my_up_meta_field' );
function my_up_meta_field() {
 return 'my_read_posts';
}
</code></pre>
up/unread_query_args 
This filter modifies the query arguments passed to the WP_Query object when querying for unread posts. Unread posts are retrieved by passing the array of read post IDs to the <code>post__not_in</code> parameter. If you would like to place additional restrictions you can do so with this filter. It receives the arguments as the first parameter.
<pre><code>add_filter( 'up/unread_query_args', 'my_up_unread_query_args' );
function my_up_unread_query_args( $args ) {
 $args['cat'] = 10;
 return $args;
}
</code></pre>
up/unread_widget_display 
This filter can modify the display of the post list in the widget. It receives three parameters. The original HTML to be displayed, the WP_Query object of unread posts and the instance variables for the widget. You can use it to completely customize the display of the posts.
<pre><code>add_filter( 'up/unread_widget_display', 'my_unread_widget_display', 10, 3 );
function my_unread_widget_display( $display, $unread, $instance ) {
 $output = '<ul>';
 while( $unread->have_posts() ) {
 $unread->the_post();
 $output = '<li>' . the_title( '', '', false ) . '</li>';
 }
 $output = '</ul>';
 return $output;
}
</code></pre>
up/show_widget 
If you want to hide the widget in the admin because you are only using the functionality of the plugin to build something yourself you can do so with this filter. Return false to hide the widget.
<pre><code>add_filter( 'up/show_widget', 'hide_up_widget' );
function hide_up_widget() {
 return false;
}
</code></pre>
up/show_settings_page 
If you want to hide the settings page in the admin because you are only using the functionality of the plugin to build something yourself you can do so with this filter. Return false to hide the settings page.
<pre><code>add_filter( 'up/show_settings_page', 'hide_settings_page' );
function hide_settings_page() {
 return false;
}
</code></pre>
up/posts_section_settings 
This filter can be used to modify the settings for the unread posts section shown below single posts. It’s only parameter is the settings it received, print that parameter to figure out all the options.
<pre><code>add_filter( 'up/posts_section_settings', 'my_posts_section_settings' );
function my_posts_section_settings( $settings ) {
 $settings['count'] = 10;
 return $settings;
}
</code></pre>
up/unread_section_display 
This filter can modify the display of the unread posts list shown below single posts. It receives three parameters. The original HTML to be displayed, the WP_Query object of unread posts and the settings for the section. You can use it to completely customize the display of the posts.
<pre><code>add_filter( 'up/unread_section_display', 'my_unread_section_display', 10, 3 );
function my_unread_section_display( $display, $unread, $settings ) {
 $output = '<ul>';
 while( $unread->have_posts() ) {
 $unread->the_post();
 $output = '<li>' . the_title( '', '', false ) . '</li>';
 }
 $output = '</ul>';
 return $output;
}
</code></pre>
up/usable_post_types 
If you would like to restrict the post types available to the plugin you can use this filter to do so. It takes the currently available post types as the first parameter.
<pre><code>add_filter( 'up/usable_post_types', 'my_usable_post_types' );
function my_usable_post_types( $post_types ) {
 $post_types = array( 'post', 'product' );
 return $post_types;
}
</code></pre>

Unread Posts

Add flexible unread post lists to your sidebar or under single posts. Easily extendable for developers wanting to leverage it.

cfischer83

Does your website utilize categories and tags? Does it use custom taxonomies? If so, this plugin will find similar content 
based on all your taxonomies. There are two ways to show related posts within your page.
<ul>
<li>The first way to show related content on your post is to use the widget provided. This only works when is_single() is true</li>
<li>The second way to show similar content on your site is to use the pk_related_return($post->ID); function which can be 
called programmatically anywhere you wish!</li>
</ul>
The Widget included with this plugin gives you the option to limit the amount of posts; it allows you to determine which 
fields to show: Featured Image, Author, Date, and Excerpt (Title is required); it allows you to determine which 
variant of the featured image to show: thumbnail, medium, large, or full. As of version 2.0, you can now decide whether the 
‘similar posts’ sorting prefers posts that are newer or posts that were created closer to the date of the post you’re 
viewing.
If you find the Widget doesn’t meet your needs or is too limiting, you can call the functionality programmatically using 
this function:
<pre><code>pk_related_return($post->ID, $args);
</code></pre>
Where $post->ID is the ID of the post for which you are wanting to show related articles.
The $args parameter is an array with the following values available to you (more coming soon):
<ul>
<li>posts_per_page (int defaults to 5)</li>
<li>thumbnail_size (string consisting of one of these values: “thumbnail”, “medium”, “large”, “full”. Defaults to thumbnail).</li>
<li>sort_prefer (string consisting of one of these values: “newest”, “closest”. Defaults to newest).</li>
</ul>
An example might be:
<pre><code><?php
$args = array (
 'posts_per_page' => 6,
 'thumbnail_size' => 'medium',
 'sort_prefer' => 'closest'
);
</code></pre>
The return value of pk_related_return is an array of objects that includes most of the fields within WordPress’s posts 
table plus permalink and featured image.
Future Additions:
Allow the user to specify only certain content types (posts, pages, custom) in a request. This would allow you to specify 
only products get returned, or only blog posts. This would only be an issue if content types share taxonomies.

Unread Posts vs Similar Posts Ontology