YARPP – Yet Another Related Posts Plugin

[yarpp] to show content related to the current post. You may use more than one YARPP shortcode in a given post or template.

[yarpp reference_id=123] to show content related to post 123

[yarpp template="yarpp-template-photoblog"] - where `yarpp-template-photoblog.php` is the file name of the custom template
[yarpp template="list"] - built-in "List" template
[yarpp template="thumbnails"] - built-in "Thumbnails" template

[yarpp template="list" limit=3]

[yarpp recent="6 month"]

[yarpp post_type="page"]

[yarpp post_type="post,page"] - include both posts and pages in results
[yarpp exclude="1,2,3"] - exclude posts with categories with IDs 1,2 and 3

[yarpp weight='{"body":1}'] - only consider body content
[yarpp weight='{"body":2,"title":2,"tax":{"category":0, "post_tag":0}}'] - give extra weight to bodies and titles, but none to categories
[yarpp require_tax='{"category": 2, "post_tag": 0}'] - require at least one category in common

<?php echo do_shortcode('[yarpp]'); ?>
<?php echo do_shortcode('[yarpp reference_id=123]'); ?>

<?php yarpp_related(); ?>

yarpp_related(
  array(
    // Pool options: these determine the "pool" of entities which are considered
    'post_type' => array('post', 'page', 'wc_product', ...), //  post types to include in results
    'show_pass_post' => true, // show password-protected posts
    'show_sticky_posts' => true, // show sticky posts
    'past_only' => true, // show only posts which were published before the reference post
    'exclude' => array(), // a list of term_taxonomy_ids. entities with any of these terms will be excluded from consideration.
    'recent' => false, // to limit to entries published recently, set to like '15 day', '20 week', or '12 month' (https://www.mysqltutorial.org/mysql-interval/)

    // Relatedness algorithm options: these determine how "relatedness" is computed
    // Weights are used to construct the "match score" between candidates and the reference post
    'weight' => array(
      'body' => 1,
      'title' => 2, // larger weights mean this criteria will be weighted more heavily
      'tax' => array(
        'post_tag' => 1,
        ... // put any taxonomies you want to consider here with their weights
      )
    ),
    // Specify taxonomies and a number here to require that a certain number be shared:
    'require_tax' => array(
      'post_tag' => 1 // for example, this requires all results to have at least one 'post_tag' in common
    ),
    // The threshold which must be met by the "match score" to be considered related
    'threshold' => 5,

    // Display options:
    'template' => 'thumbnails', // which theme/custom template to use. Built-in ones include "list" and "thumbnails", or the name of a YARPP template file in your active theme folder starting with "yarpp-template-". Example: yarpp-template-videos or yarpp-template-videos.php
    'limit' => 5, // maximum number of results
    'order' => 'score DESC', // column on "wp_posts" to order by, then a space, and whether to order in ascending ("ASC") or descending ("DESC") order
    'promote_yarpp' => true, // boolean indicating whether to add 'Powered by YARPP' below related posts
    'generate_missing_thumbnails' => true, // automatically generate missing thumbnail sizes on the fly
    'extra_css_class' => 'class_1 class_2', // add CSS classes to YARPP's parent div
  ),
 $reference_ID, // second argument: (optional) the post ID. If not included, will use the current post.
 true // third argument: (optional) true to echo the HTML block; false to return it
);

$result = get_transient('yarpp_custom_results_for_' . $post->ID);
if(! $result){
  $result = yarpp_related(['post_type' => 'reply'],null,false);
  set_transient('yarpp_custom_results_for_' . $post->ID, $result, DAY_IN_SECONDS);
}
echo $result;

yarpp_related(
  array(
    'limit' => 4,
    'weight' => array(
      'title' => 1,
      'tax' => array(
        'category' => 2
      )
    ),
    'post_type' => 'wc_product',
    'template' => 'yarpp-related-wc-products.php'
  )
);

$related_posts = yarpp_get_related(array(), 123);
if(! $related_posts){
  echo 'No related posts';
} else {
  foreach($related_posts as $post){
    // $post is a WP_Post object.
    echo $post->post_title;
  }
}

変更履歴

5.30.2 (29-January-2023)

• Bugfix: Improved how function attributes are sanitized to avoid possible security issues

5.30.1 (08-November-2022)

• Bugfix: Fixes issue caused by stricter type checks for arithmetic operators in PHP8

5.27.8 (01-December-2021)

• New: [yarpp] shortcode supports all the same parameters as yarpp_related(). See the updated documentation.
• Bugfix: Apply the additional CSS class(es) defined in YARPP Advanced Block settings

5.27.7 (29-October-2021)

• Enhancement: CSS improvements for better cross-theme compatibility
• Documentation: Available YARPP filters

5.27.6 (12-October-2021)

• Bugfix: Support for drop-in caches. Resolves Undefined variable: found warnings.
• Bugfix: Add missing string for translations
• Bugfix: Workaround for WordPress ca-bundle.crt issue
• Bugfix: Properly update the template preview in YARPP’s admin console when Thumbnail size selection is updated
• Bugfix: Use dummy example thumbnail in previews
• Enhancement: For RSS Feed Display Options use dropdown select for thumbnail sizes instead of radio buttons

5.27.5 (15-September-2021)

• New: Add support for “show_sticky_posts” and “generate_missing_thumbnails” to the yarpp_related() function
• New: Add support for “recent” in YARPP shortcode
  • For example, to limit results to those published in the past 12 months: [yarpp recent="12 month"]
• Enhancement: For Automatic Display Options use dropdown select for thumbnail sizes instead of radio buttons

5.27.4 (25-August-2021)

• Bugfix: PHP 8 compatibility by making $args optional on YARPP::get_template_content()

5.27.3 (16-August-2021)

• Bugfix: Make $related_query available to custom templates

5.27.2 (12-August-2021)

• New: Conversion of legacy widget YARPP block into YARPP Block
• Bugfix: New Blocks on widget’s sections were showing on homepage
• Bugfix: Remove the legacy widget YARPP block on the widgets interface
• New: Option to add a custom reference ID on a YARPP Block
• Enhancement: Consistency on “Heading” input fields on widgets and blocks
• Enhancement: Show demo related post on the Widgets YARPP Blocks

5.27.1 (03-August-2021)

• Bugfix: i18n / localization for new text strings was not working.
  • P.s. YARPP is available for translation directly on WordPress.org. Please check out the official Translator Handbook.
• Bugfix: Remove YARPP’s WP_Query filters after the query is done rather than waiting until rendering is done because any queries done in that time will be affected.

5.27.0 (20-July-2021)

• WordPress v5.8 compatibility
• Bugfix: Fixes PHP debug notice “Trying to get property ‘ID’ of non-object”

5.26.0 (14-July-2021)

• New: Adds a yarpp_add_image_size filter to avoid creating YARPP thumbnail sizes
  • add_filter( 'yarpp_add_image_size', '__return_false' );
• New: Preview YARPP Templates on the YARPP settings page under Automatic Display Options
• Docs: Added FAQ on how to remove sold out WooCommerce products from recommendations (and otherwise filter by postmeta)

5.25.0 (23-June-2021)

• Enhancement: Cleaned up old unused code (adkengage)

5.24.0 (17-June-2021)

• Enhancement: Option to automatically generate missing thumbnail sizes on the fly when using Custom YARPP Templates
• New: Adds a noyarpp filter to control YARPP Automatic Display programatically.
  • For example: add_filter( 'noyarpp', 'custom_function' );
• Enhancement: Use the faster and less memory intensive function strpos() instead of stristr()

5.23.0 (02-June-2021)

• New: Ability to specify maximum number of posts to show in the YARPP shortcode.
  • For example, to set maximum post limit to 3: [yarpp template="list" limit=3]
• Bugfix: Check wp_parse_list exists for backwards compatibility to older versions of WordPress
• Bugfix: Use query parameters when priming cache using yarpp_related. Resolves bug with yarpp_function not fully accounting for all parameters passed to it.

5.22.0 (24-May-2021)

• New: Choose the exact post types to include in “The Pool”
• New: Ability to specify built-in YARPP templates in the YARPP shortcode. You may use more than one YARPP shortcode in a given post or template and each can have a different template specified. For example:
  • [yarpp template="yarpp-template-simple"] // where yarpp-template-simple.php is the file name of the custom YARPP template in your active theme folder
  • [yarpp template="list"] // built-in “List” template
  • [yarpp template="thumbnails"] // built-in “Thumbnails” template
• Enhancement: YARPP Automatic Placement, YARPP Shortcode, YARPP Block, YARPP Widget and RSS output are all now wrapped in a div with classes yarpp, yarpp-related and yarpp-template-TEMPLATE-NAME to facilitate easier CSS customizations
• Enhancement: All admin CSS is now minified

5.21.0 (14-May-2021)

• Bugfix: Disable “Edit as HTML” for YARPP Block
• Bugfix (1|2): Fixes issue with the correct template not being applied

5.20.0 (06-May-2021)

• New: Option to automatically generate missing thumbnail sizes on the fly
• New: Option to include or exclude Sticky Posts
• Enhancement: Dynamic CSS for the built-in “Thumbnails” theme is now in-lined for much improved cross compatibility with optimization and caching plugins
• Bugfix: Fixes conflict with the Page Optimize plugin

5.19.0 (28-April-2021)

• New: YARPP Block 🎉 now available for the WordPress Block Editor (Gutenberg) for drag and drop placement customization
• New: Choose image size for YARPP custom theme templates
• Bugfix: Indicate yarpp_meta postmeta is protected to prevent themes from displaying it
• Bugfix: Check wp_get_additional_image_sizes exists for backwards compatibility to older versions of WordPress

5.18.2 (19-April-2021)

• Bugfix: Allow default WP image sizes to be picked for the YARPP Thumbnail theme

5.18.1 (19-April-2021)

• New: Choose image size for YARPP Thumbnail theme
• Bugfix: Resolves join warning (Part 2/2)

5.17.0 (06-April-2021)

• New: Adds yarpp_enqueue_related_style filter to be able to dequeue related.css
  • add_filter( 'yarpp_enqueue_related_style', '__return_false' );
• New: Adds friendly per-post meta box options to disable YARPP automatic display on a specific post

5.16.1 (29-March-2021)

• Bugfix: include new minified JS files

5.16.0 (29-March-2021)

• Enhancement: Switches to minified JavaScript in YARPP Admin for a speed boost
• Bugfix: Resolves conflict with Easy Forms for MailChimp which was preventing YARPP settings from being saved
• Bugfix: Resolves join warning (Part 1/2)

5.15.3 (15-March-2021)

• Enhancement: Improves readability of the database indexes prompt

5.15.2 (12-March-2021)

• Tested up to WordPress 5.7

5.15.1 (11-March-2021)

• Bugfix: Fixes issue pushing 5.15.0

5.15.0 (11-March-2021)

• Enhancement: Default to not comparing using titles and bodies and only add database indexes when they are enabled to improve performance
• Enhancement: Default algorithm threshold changed from 4 to 1 to more reliably find related content on new installs
• Enhancement: Clear cache button uses modal dialogs instead of native browser alerts
• Bugfix: apparent Oxygen Builder conflict

5.14.0 (9-March-2021)

• Enhancement: Improve pageload speed by avoiding checking YARPP database requirements on frontend requests

5.13.1 (1-March-2021)

• Add some of 5.13.0’s changes that somehow weren’t included

5.13.0 (1-March-2021)

• New: Clear YARPP cache button on settings page
• Bugfix Undefined variable “$post_types`

5.12.0 (22-February-2021)

• New shortcode template attribute. Eg [yarpp template="yarpp-template-photoblog"]
• PHP 8.0 compatibility
• Deprecated: functions related_posts(), related_pages() and related_entries() [useyarpp_related() instead`]
• Deprecated: functions related_posts_exist(), related_pages_exist() and related_entries_exist() [use yarpp_related_exist() instead]
• Bugfix: consistently use “post_type” parameter and “cross-relate” from all YARPP functions
• Bugfix: Add textdomain to allow translating the readme file

5.11.0 (08-February-2021)

• New: Adds native support for bbPress! Have you ever wanted a nifty Related Posts section on your bbPress topic pages, like the ones you’ve seen on forums like StackOverflow? It’s now possible with YARPP Related Posts!
• Enhancement: Updates to provided custom template examples
• Enhancement: YARPP post metabox enhancements – adds “edit” and “view” hover options to each link, mimicking the main posts table
• Enhancement: Add missing debug info
• Bugfix: Avoid REST API warning by providing the page parameter which WP core expects
• Deprecated: functions YARPP::maybe_enqueue_thumbnails() and YARPP::enqueue_thumbnails()

5.10.2 (23-November-2020)

• Enhancement: Faster queries and a speed boost ⚡️ (Re-introduces database query improvements while avoiding the fatal error identified by some in v5.10.0)
• Enhancement: Speed up by not loading widget.css when not necessary
• Bugfix: Part 2 of 2 – Resolves jQuery Migrate Helper warnings
• Bugfix: Fixes PHP warning on options page
• Bugfix: Fixes integration with Algolia search
• Bugfix: Respect “Require at least 1 {Taxonomy} in common” when you press “refresh” in the meta box while editing a post

5.10.1 (23-October-2020)

• Critical Bugfix: Reverts query changes from the v5.10.0 update as it caused 500 fatal errors on some WordPress installations. We sincerely apologies for any issues it may have caused. We did test the release for weeks, but each environment is just a bit different. We are actively testing a bug fix with those affected that volunteered before we release it again.

5.10.0 (22-October-2020)

• Enhancement: Faster queries and a speed boost ⚡
• Enhancement: On posts with page breaks, show YARPP only on the last page
• Enhancement: Documentation on how to use [yarpp] shortcode from a theme file (like single.php) or post content
• Bugfix: If YARPP has already added its content to a post and somehow apply_filters('the_content'...) gets called again, don’t try to re-add YARPP’s content to the post again.
• Bugfix: Fixes showing/hiding excerpt options when checking excerpt checkboxes
• Bugfix: Fixes “role” in deactivation survey
• Bugfix: Fixes PHP warning on options page
• Bugfix: Part 1 of 2 – Resolves jQuery Migrate Helper warnings

5.9.0 (21-September-2020)

• Enhancement: Clarify that “Also display in archives” includes front page and category pages
• Enhancement: reference_id parameter support for the YARPP shortcode. For example: [yarpp reference_id=123] to show content related to Post ID 123 (can be used either inside or outside the loop from theme code)
• Enhancement: Place warning about comparing using titles and bodies next to the affected inputs, rather than at the top of the page where it could be lost with notices from other plugins
• Bugfix: Don’t require a category or term, even if set by the admin, on post types that don’t use categories or terms (also applies to custom taxonomies)

5.8.0 (08-September-2020)

• Enhancement: Code hygiene upgrade with usage of WPDB->prepare everywhere possible and related improvements
• Bugfix: Since there is no YARPP Pro currently, removed mention of it from the widget form

5.7.0 (18-August-2020)

• Enhancement: Ensure that when a post is finally published, YARPP cache for peer posts is cleared to ensure the most related posts are always recommended across every post
• Bugfix: Fixed warning in Admin UI caused by an unnecessary HTML comment
• Bugfix: When priming YARPP’s cache, if “Display posts from other post types” is false, we now only include posts of the current post type

5.6.0 (13-August-2020)

• New: Configurable in-browser caching option for YARPP REST API
• Bugfix: Always include unused categories and terms in YARPP Admin options
• Bugfix: Fixed issue with loading CSS files from wrong domain on multilingual sites
• Various Admin UI fixes

5.5.0 (06-August-2020)

• New: Support for custom page types and taxonomies, including those added by WooCommerce
• Enhancement: Show spinner while full-text indexes are being created
• Enhancement: Various YARPP Admin UX/UI improvements
• Bugfix: Fixes bug where Review Notice was not getting dismissed for non-admins
• Bugfix: Exclude Gutenberg blocks so that they don’t appear as related

5.4.0 (03-August-2020)

• New: Shortcode support! [yarpp] (documentation)
• Enhancement: Adds YARPP score to REST API responses (documentation)
• Enhancement: Prepare for default jQuery version update in upcoming WordPress Core
• Bugfix: Fixed admin panel tooltips
• Bugfix: Fixed admin panel “copy template” button

5.3.0 (29-July-2020)

• New: REST API support! (documentation)
• Enhancement: WP Rest Cache Plugin support
• Enhancement: Adds filters to change the priority for YARPP’s filters on the_content, the_content_feed and the_excerpt_rss
  • For example: add_filter( 'yarpp_content_priority', 1 );
• Bugfix: Fixes deactivation survey when Google Translate in Chrome auto translates the admin page

5.2.2 (21-July-2020)

• Critical Bugfix: Fixes plugin upgrade process. This in turn fixes a page slow down issue introduced for some sites with v5.2.0.

5.2.1 (20-July-2020)

• Enhancement: Don’t recommend switching database engine unless necessary for fulltext indexes.

5.2.0 (20-July-2020)

• Enhancement: Adds support for InnoDb fulltext search! One of our most requested features. Fulltext indexing is supported in MyISAM or InnoDB with MySQL 5.6.4 and higher.
• Enhancement: Optimized database queries, resulting in ~2x speed improvement in some queries.

5.1.9 (25-June-2020)

• Bugfix Fixes deactivation survey plugin conflict

5.1.8 (17-June-2020)

• Bugfix Add missing file to previous release!

5.1.7 (17-June-2020)

• Bugfix Double-check database indexes exist before creating them
• Bugfix: Titles were only being considered if body text was also considered for the relatedness algorithm. This update fixes the logic to work where only titles are set to be considered.
• Bugfix: Do not dismiss deactivation modal when clicking outside it

5.1.6 (15-May-2020)

• Bugfix: 403 error when saving changes resolved
• Enhancement: Feedback form enhancements

5.1.5 (11-May-2020)

• Bugfix: Use correct deactivation reason code

5.1.4 (11-May-2020)

• Require PHP 5.3 as a bare minimum for compatibility features
• New: Display optional feedback form on plugin deactivation

5.1.3 (07-April-2020)

• Support for WordPress 5.4+
• Enhancement: Switch over to secure (https) endpoints

5.1.2 (06-November-2019)

• Support for WordPress 5.3+

5.1.1 (23-September-2019)

• Enhancement: Review Notice updates + instructions on how to disable it programmatically

5.1.0 (10-July-2019)

• Bugfix: Related Posts metabox did not load within Gutenberg Editor
• Bugfix: Fixed ‘Deactivate YARPP Pro’ button, including moving functionality to proper WP AJAX functions
• Enhancement: Related Post thumbnails should not be ‘pinnable’ to Pinterest
• Enhancement: Review Notice
• Enhancement: Modernized Editor Metabox design
• Enhancement: Added ‘Refresh’ button to Editor Metabox

5.0.1 (08-July-2019)

• Bugfix: Fixed invalid CSS rule
• Enhancement: Set Cache headers for CSS file

5.0.0 (01-July-2019)

• Bugfix: Fixed warning from using get_currentuserinfo()

4.6 (01-July-2019)

• Bugfix: Removed links from Plugin Readme to resolve WordFence false positive.

4.5 (18-May-2019)

After a bit of a hiatus, we’re back! The plugin had been delisted due to a minor email address issue. This has been resolved with this release and the plugin has been reinstated. We consider this to be a big step, and yes, after a 6-month hiatus of not being in the plugin directory.🙂

The plugin is also no longer maintained by Adknowledge. A group of us with deep expertise in Content Recommendations and 10+ years experience with maintaining very popular plugins have very recently taken Yarpp over from Adknowlege. More on this will be shared very soon.

After a break of many years, the plugin is 100% supported now that the baton has been passed on. A larger update (hand-in-hand with proper communication) is being carefully worked on with a focus on a host of bug fixes and compatibility updates which will be available once it is properly tested, ready and updates properly communicated. Stay tuned.❤️

4.4

• Discontinuing the YARPP Pro service

4.3.6

• Removed new file

4.3.5

• Fix ‘unable to update’

4.3.4

• Don’t allow new YARPP Pro signups
• Discontinuing the YARPP Pro service as of 01/31/2017

4.3.3

• Fix ‘Undefined index’ in YARPP_Cache.php (credit to Derrick Hammer/@pcfreak30)

4.3.2

• Fix ksort error in YARPP_Cache.php (credit to Derrick Hammer/@pcfreak30)
• Discontinuing the YARPP Pro service as of 12/31/2016

4.3.1

• Tested on WordPress 4.4.
• Fix $lang missing error in YARPP_Cache.php
• Fix WP_Widget deprecation PHP error

4.2.5

• Tested on WordPress 4.2.2.
• Styling fix: User can now override all YARPP CSS styling

4.2.4

• Bugfix: Missing internal version number update

4.2.3

• Tested on WordPress 4.0.
• Bugfix: Made logo image url in css scheme-less (fix http/https)

4.2.2

• Tested on WordPress 3.9.1.
• Bugfix: Duplicate related post links removed.
• Bugfix: Removed extra <br> at the end of post content.

4.2.1

• Bugfix: Resolved the issue related to “Warning: in_array() expects parameter 2 to be array, null given”.

4.2

• Tested on WordPress 3.9.
• YARPP Basic and YARPP Pro can now be used simultaneously, rather than being mutually exclusive.
• Added a YARPP Pro option to the YARPP sidebar widget.
• Enlarged “Display Options” panel textbox for increased usability.
• Updated YARPP Pro script to allow for future enhancements.
• Updated MyISAM check notice message to explain its impact on “Pages.”
• Added descriptive text to explain new enhancements.

4.1.2

• Tested on WordPress 3.8.
• Added field boxes with API Key information to Domain page.
• MyISAM check notice message was updated to better express what it does and a feedback message was added in case the fulltext index creation fails.
• Bugfix: MyISAM check overwrite was broken since 4.1.x release.
• Bugfix: PHP title not defined warning when creating new cache entry.
• Bugfix: Uninstall script now deletes options with empty, false or 0 values.
• Bugfix: Scrollbar functionality on YARPP Pro Domain Settings page.

4.1.1

• Bugfix: Incompatibility with PHP < 5.3.x

4.1

• Added optional YARPP Pro enhancements:
  • Revenue-generating ad content interspersed with related posts display
  • Detailed reports for Clicks, Click-Through Rate, and Revenue
  • Ability to display related content from multiple domains
  • UI settings for related content display, including thumbnail size and layout
  • Refined “relatedness” algorithm is now independent of MyISAM or InnoDB engines
  • “Relatedness” is calculated and stored externally, minimizing server load
• Based on user feedback, the “Screen Options” section displays all YARPP options panels by default.

4.0.8

• The recent 4.0.7 YARPP update included a settings modification to opt in users to our tracking pixel by default. By doing so, our intent was to use this expanded information to better understand the geographic reach of the popular plugin. We have been made aware that this change infringed upon the WordPress guidelines. We apologize for the issue and have remedied the situation in update 4.0.8. Going forward, we would really appreciate your input to help us continue to improve the product. We are primarily looking for country, domain, and date installed information. Please help us make YARPP better by opting in to this information and by filling out our quick, 5 question survey. Thank you.

4.0.7

• Bugfix: Now more robust against certain custom options.
• Updated plugin de-activate/delete functionality to drop all tables. Prior to fix some legacy tables remained which required manual deletion in wp_options from phpmyadmin.
• Updated FAQs section.
• Update to YARPP’s data collection terms and conditions.
• Added Macedonian (mk_MK) localization by WPdiscounts.

4.0.6

• YARPP’s automatic display will not run on posts which include the HTML comment <!--noyarpp--> by request.
• More robust activation handling, particularly when network-activated.
• Improved handling of exceptions, for example when fulltext indexes cannot be created or non-MyISAM tables are used.
• YARPP no longer triggers the generation of YARPP-thumbnail-sized images (120×120) when YARPP thumbnails are not used.
  • If you are using YARPP programmatically and using the thumbnails view and having troubles with YARPP’s thumbnail size being registered, a manual control to force image size registration has been added to the YARPP Experiments plugin.
• Bugfix: calls to yarpp_related_exist() type functions were causing errors.
• Bundled yarpp-template-wpml.php is now called yarpp-template-multilingual.php, following discussion with the author of the Polylang plugin.
• Localizations
  • Added Estonian (est_EST) by journal24.info
  • Added Gujrati (gu_IN) by Vikas Arora of wiznicworld.com

4.0.5

• Bugfix: Some upgrade code would try to access the global $yarpp before it was properly initialized
• Added experimental graph data method to the YARPP table cache class

4.0.4

• Bugfix: 4.0.3 broke some paginated post displays
• Bugfix: custom post type support was not working properly in widget displays
• Bugfix: widget control JS was not working right when first adding a widget
• Added ability to set widget-specific heading for the thumbnails view, by request
• Added the filter yarpp_results
• Localizations:
  • Updated French localization and stopword list
  • Added Slovenian (sl_SI) localization by Silvo Katalenić
• Bugfix: forces the DB Cache Reloaded (Fix) plugins to flush when necessary

4.0.3

• Bugfix: on sites where custom templates are not available, the “thumbnails” display option would get reset when visiting the YARPP settings page
• Bugfix: the CSS for YARPP’s thumbnails display would load at the foot of the page, and therefore would cause some style-flashing. This is fixed for automatic includes, but not for widgets or manual calls.
• Restoration of the $post global after YARPP is now more robust. Fixes the display of incorrect metadata on some complex themes.
• YARPP template files no longer recognize Template Name fields in their headers, instead using YARPP Template. This is to avoid confusion with regular page templates.
• Added “Related Posts” meta box to other “auto display” post types
• Updated Polish localization

4.0.2

• Bugfix: cache should be cleared when the “show only previous posts?” option is changed
• Bugfix: In the thumbnail display, sometimes the default image was not displayed, even though no post thumbnail was available.
• Localization updates
  • Updated Polish, Japanese, Hebrew localizations
  • Better right-to-left layout support

4.0.1

• Improvements to thumbnail handling
  • See new FAQ entry for practical details
  • Thumbnail size can be specified programmatically (see FAQ)
  • YARPP now registers its thumbnail size properly as yarpp-thumbnail
  • Fixed a typo and simplified an item in the dynamic styles-thumbnails.php styles
  • Code to generate thumbnails of appropriate size on the fly has been added, but is turned off by default for performance reasons (see FAQ)
• Bugfix: a class of yarpp-related- with a stray hyphen was sometimes being produced. Now fixed so it produces yarpp-related.
• Bugfix: term_relationships table was being joined when unnecessary
• Bugfix: widget options would not display if custom templates were not available
• Bugfix: some transients expired too soon if object caching was used
• The yarpp_map_post_types filter now also applies to feeds and takes an extra argument to know whether the context is website or rss.

4.0

• New thumbnail template option!
  • No PHP required—just visit the settings page
  • Edit your theme’s CSS file to modify the styling
• Auto display settings changes:
  • Easily choose which post types you want related posts to display on
  • Added an “also display in archives” option
• Bugfix: uses of related_posts_exist() and get_related() without explicit reference ID parameter would incorrectly return no related posts.
• Changes to the output HTML:
  • All YARPP output is now wrapped in a div with class yarpp-related, yarpp-related-widget, or yarpp-related-rss as appropriate (by request). If there are no results, a yarpp-related-none class is added.
  • The “related posts brought to you by YARPP” text is only added if there were results.
• Refinements to settings UI:
  • A new design for the template chooser
  • Example code display is now hidden by default; turn them back on from the “screen options” tab.
  • A new “copy templates” button allows one-button installation of bundled templates into the current theme, if filesystem permissions make it possible.
  • Header information in YARPP custom templates are now displayed to users in the settings UI. Available fields are YARPP Template, Description, Author, Author URI, in the same format as plugin and theme file headers. See bundled templates for examples.
• Code cleanup:
  • Settings screen UI have been rewritten to use divs rather than tables!
  • Inline help in settings screen now use WordPress pointers
  • Removed keyword cache table, as it does not ctually improve performance much and the overhead of an additional table is not worth it.
• Default option changes:
  • Default result count is now 4
  • Default match threshold is now 4
  • Default for “before related entries” heading uses h3 instead of p
• Added yarpp_map_post_types filter to programmatically specify what post types should be looked at for automatic displays
• Added option to send YARPP setting and usage information back to YARPP (off by default). This information will be used to make more informed decisions about future YARPP development. More info available in the settings.

3.5.6

• Typo fix for postmeta cache
• Added Traditional Chinese (Taiwan, zh_TW) localization by Pseric

3.5.5

• Quick bugfix for how admin screen code was loaded in in WordPress < 3.3.

3.5.4

• New Help tab, which displays help text from the readme.
• Retina icons! Now served faster, in sprite form.
• Added Croatian (hr) localization by gocroatia.com
• Cleanup:
  • Bugfix: stopwords would not be loaded if WPLANG is defined but blank.
  • Added new stats method to YARPP_Cache_* objects.
  • Load meta boxes on screen_option hook. Improves performance on admin pages.
  • Changed default option of “show only previous posts” to false and removed FAQ text, as it no longer improves performance much.

3.5.3

• Bugfix: Fixed a common cause of “no related posts”!
• Better post revision handling
• Bugfix: setup wasn’t automatic for network activations.
• Code cleanup:
  • Bugfix: tables should be created using WordPress charset settings
  • YARPP_Cache_*::update methods are now protected
  • Simplified some post status transition handling
  • Ensure that delete_post hook receives relevant post ID information
  • Various functions now refer to the enforce method which will activate if it’s a new install, or else upgrade if necessary. (Part of the fix for the network activation above.)

3.5.2

• Bugfix: fix an unfortunate typo which caused “no related posts” on many environments with non-MyISAM tables
• Fixed a bug where related posts would not be recomputed on post update, on environments using the table YARPP cache method and a persistent object caching system, like W3 Total Cache or memcached
• Bugfix: reference to get_post_types() failed in ajax display
• Fixed a bug where some RSS display options were not being obeyed
• Fixed a bug where the “automatic display” was being displayed on some custom post types without any control.
• Localizations:
  • Added Czech (cs_CZ) localization by Zdenek Hejl
  • Added Serbian (sr_RS) by Zarko Zivkovic
  • Fixed bug in Dutch localization
• Clarified readme to require WordPress 3.1
• Code cleanup:
  • PHP 5.3+: replaced an instance of ereg_replace
  • Removed warning on settings save
  • Sometimes a warning was printed on upgrade from YARPP < 3.4.4
  • Fixed PHP warning when no taxonomies are considered
  • No longer using clear_pre function which has been deprecated since WordPress 3.4.

3.5.1

• Bugfix: change $yarpp->get_post_types() to return array of names by default
• Ensure that all supported post types are used when “display results from all post types” is set

3.5

• New public YARPP query API, which supports custom post types
  • Documentation in the “other notes” section of the readme
  • Changed format of weight, template, recent parameters in options and in optional args
• Further main query optimization:
  • What’s cooler than joining four tables? Joining two.
  • Exclude now simply uses term_taxonomy_ids instead of term_ids
• Bugfix: “related posts” preview metabox was not always working properly
• Changes to the related_*() and yarpp_related() function signatures.
• Added “consider with extra weight” to taxonomy criteria as well
• Code cleanup:
  • Don’t clear the cache when it’s already empty
  • protect the sql method as it shouldn’t be public
  • Further use of utility functions from 3.1 like wp_list_pluck()
  • New constant, YARPP_EXTRA_WEIGHT to define the “extra weight.” By default, it’s 3.
• Localizations:
  • Added Slovak (sk_SK) localization by Forex
  • Added Romanian (ro_RO) localization by Uhren Shop
  • Updated it_IT, ko_KR, fr_FR, sv_SE, ja localizations

3.4.3

• Bugfix: keywords were not getting cleared on post update, meaning new posts (which start blank) were not getting useful title + body keyword matches. This often resulted in “no related posts” for new posts.
• Postmeta cache: make sure to clear keyword cache on flush too
• Make welcome pointer more robust
• More custom post type support infrastructure
• Updated Turkish localization by Barış Ünver

3.4.2

• Bugfix: 3.4 and 3.4.1 assumed existence of wp_posts table.
• Fix typo in yarpp-template-random.php example template file
• Improve compatibility with DB Cache Reloaded plugin which doesn’t properly implement set_charset method.

3.4.1

• Bugfix: restore global $post access to custom templates
• Bugfix for missing join_filter on bypass cache
• Bugfixes to query changes:
  • Bugfix: Shared taxonomy terms were not counted correctly
  • Bugfix: exclusion was not working
• Bugfix: “disallow” terms were not being displayed for custom taxonomies.
• Add defaults for the post_type arg
• Strengthen default post ID values for related_* functions
• Added nonce to cache flushing. If you would like to manually flush the cache now, you must use the YARPP Experiments plugin.
• Updated sv_SE, ko_KR, fr_FR localizations

3.4

• Major optimizations to the main related posts query, in particular with regard to taxonomy lookups
  • Performance improvements on pages with “no related posts”
• Now can consider custom taxonomies (of posts and pages), in addition to tags and cateogories! Custom taxonomies can also be used to exclude certain content from The Pool.
• Add welcome message, inviting users to check out the settings page
• Bug fix: Custom templates could not be used in widget display
• Significant code cleanup
  • Move many internal functions into a global object $yarpp of class YARPP; references to the global $yarpp_cache should now be to global $yarpp->cache
  • Created the “bypass” cache engine which is used when custom arguments are specified.
    • Switch to bypass cache for demos
  • Now only clears cache on post update, and only computes results for actual posts, not revisions (thanks to Andrei Mikhaylov)
  • Removed the many different options entries, replacing them with a single yarpp option (except yarpp_version)
  • Fixed issues with display options field data escaping and slashing once and for all
  • Streamlined keyword storage in YARPP_Cache_Postmeta
  • Create YARPP_Cache abstract class
  • Updated minor bug for computing how many results should be cached
  • Adding some filters: yarpp_settings_save, yarpp_blacklist, yarpp_blackmethods, yarpp_keywords_overused_words, yarpp_title_keywords, yarpp_body_keywords, yarpp_extract_keywords
  • New systematic use of YARPP_ constants to communicate cache status
  • Use get_terms to load terms
• Get lazy and embrace asynchronicity:
  • Implement lazy/infinite scrolling for the “disallow tags” and “disallow categories,” so the YARPP settings screen doesn’t lock up the browser for sites which have a crazy number or tags or categories
  • Don’t compute related posts for the metabox on the edit screen; display them via ajax instead
  • Only clear cache on post save, not recompute
• Added yarpp_get_related() function can be used similar to get_posts()
• Support for YARPP Experiments.
• Fix formatting of the Related Posts meta box
• Localizations
  • Updated it_IT localization
  • Added Portuguese stopwords by Leandro Coelho Logística Descomplicada

3.3.3

• Bug fix: a fix for keyword computation for pages; should improve results on pages. May require flushing of cache: see FAQ for instructions.
• Init YARPP on the init action, for compatibility with WPML
• Updated Polish, Italian, and Japanese localizations; added Dutch stopwords by Paul Kessels
• Code cleanup:
  • Minor speedup to unnecessarily slow i18n code
  • Fixed fatal error in postmeta keyword caching code
  • Fewer globs
  • Bug fix: ignore empty blog_charsets

3.3.2

• Bugfix: removed an unlocalized string
• Bugfix for users of WordPress 3.0.x.

3.3.1

• Quick bugfix to relatedness options panel bug

3.3

• Pretty major rewrite to the options page for extensibility and screen options support
  • By default, the options screen now only show the display options. “The Pool” and “Relatedness” options can be shown in the screen options tab in the top right corner of the screen.
  • Removed the “reset options” button, because it wasn’t actually doing anything.
• Rebuilt the new version notice to actually have a link which triggers the WordPress plugin updater, at least for new full versions
• Changed default “relatedness” settings to not consider categories, to improve performance
• Added BlogGlue partnership module
• Localizations
  • Quick fix to Czech word list file name
  • Updated Italian localization (it_IT)
  • Added Hungarian (hu_HU) by daSSad
  • Added Kazakh (kk_KZ) by DachaDecor
  • Added Irish (gb_IR) by Ray Gren

3.2.2

• Now ignores soft hyphens in keyword construction
• Minor fix for “cross-relate posts and pages” option and more accurate related_*() results across post types
• Localization updates:
  • Updated de_DE German localization files
  • Fixed an encoding issue in the pt_PT Portuguese localization files
  • Added es_ES Spanish localization by Rene of WordPress Webshop
  • Added ge_KA Georgian by Kasia Ciszewski of Find My Hosting
  • Added Czech (cs_CZ) overused words list by berniecz

3.2.1

• Bugfix: Duplicate results shown for some users
• Bugfix: With PHP4, the “related posts” would simply show the current post
  • This was due to an issue with object references in PHP4. What a pain!
  • A big thanks to Brendon Held of inMotion Graphics for being incredibly patient and letting me try out different diagnostics on his server.
• Better handling of post_status transitions.
• Bugfix: the widget was not working on pages
• Added overused words list for French, thanks to saymonz
• Minor code cleanup:
  • Fixed a bug in yarpp_related_exists()
  • Removed legacy code for gracefully upgrading from YARPP versions < 1.5 and working with WordPress versions < 2.8.
  • Cleanup of yarpp_upgrade_check() calling
  • Cleanup of yarpp_version_json(), including caching and minor security fix
  • Eliminated a couple globals
  • Cleaned up some edge case causes for “unexpected output” on plugin activation
  • Removed WP Help Center badge, as they are closing

3.2

• Better caching performance:
  • Previously, the cache would never actually build up properly. This is now fixed. Thanks to Artefact for pointing this out.
  • The appropriate caches are cleared after posts are deleted (#1245).
  • Caching is no longer performed while batch-importing posts.
• A new object-based abstraction for the caching system. YARPP by default uses custom database tables (same behavior as 3.1.x), but you now have an option to use the postmeta table instead. To use postmeta caching, add define('YARPP_CACHE_TYPE', 'postmeta'); to your wp-config.php file.
• Localizations:
  • added Bulgarian (bg_BG) by Flash Gallery
  • added Farsi/Persian (fa_IR) by Moshen Derakhshan
  • added Bahasa Indonesia (id_ID) by Hendry Lee of Kelayang
  • added Norwegian (nb_NO) by Tom Arne Sundtjønn
  • added Portuguese (pt_PT) by Stefan Mueller
  • updated Lithuanian (lt_LT) by Mantas Malcius
• Added WordPress HelpCenter widget for quick access to professional support.
• Some code cleanup (bug #1246)
• No longer supporting WordPress versions before 3.0, not because I suddenly started using something that requires 3.0, but in order to simplify testing.

3.1.9

• Added Standard Arabic localization (ar) by led
• The Related Posts Widget now can also use custom templates. (#1143)
• Fixed a conflict with the Magazine Premium theme
• Fixes a WordPress warning of “unexpected output” on plugin installation.
• Fixes a PHP warning message regarding array_key.
• Fixed a strict WordPress warning about capabilities.
• Bugfix: widget now obeys cross-relate posts and pages option
• For WPMU + Multisite users, reverted 3.1.8’s get_site_options to get_options, so that individual site options can be maintained.

3.1.8

• Added Turkish localization (tr_TR)
• Bugfix: related pages and “cross-relate posts and pages” functionality is now working again.
• Some bare minimum changes for Multisite (WPMU) support.
• Reimplemented the old “show only previous posts” option. May improve performance for sites with frequent new posts, as there is then no longer a need to recompute the previous posts’ related posts set, as it cannot include the new post anyway.
• Minor bugfix to threshold limiting.
• Minor fix which may help reduce strip_tags() errors.
• Updated FAQ.
• Code cleanup.

3.1.7

• Added Egyptian Arabic localization (ar_EG)
• Changed default option for automatic display of related posts in feeds to OFF. May improve performance for new users who use the default settings.
• “Use template” options are now disabled when templates are not found. Other minor tweaks to options screen.
• 3.1.7 has been lightly tested with WP 3.0. Multisite (WPMU) compatibility has not been tested yet.

3.1.6

• Added Latvian localization (lv_LV)
• Added a template which displays post thumbnails; requires WordPress 2.9 and a theme which has post thumbnail support

3.1.5

• Quick bugfix to new widget template (removed extra quote).

3.1.4

• Improved widget code
• Localization improvements – descriptions can now be localized
• Compatibility with PageBar – thanks to Latz for the patch!
• Bugfix: related_posts_exist was giving incorrect values
• Bugfix: SQL error for setups with blank DB_CHARSET

3.1.3

• Performance improvements:
  • Turning off cache expiration, made possible by smarter caching system of 3.1 – should improve caching database performance over time.
  • updated primary key for cache by Pinoy.ca – improves client-side pageload times.
• Code cleanup
  • Rewrote include and require paths
• Bugfix: localizations were not working with WordPress 2.9 (a CodeStyling Localizations bug)
• Bugfix: redundant entries for “unrelatedness” were being inserted
• Bugfix: yarpp_clear_cache bug on empty input
• Version checking code no longer uses Snoopy.
• New localization: Hindi by Outshine Solutions

3.1.2

• Bugfix: saving posts would sometimes timeout

3.1.1

• Possible fix for the “no related posts” issue by vkovalcik
• Bugfix: slight optimization to keyword function by vkovalcik
• Bugfix: regex issue with br-stripping

3.1

• New snazzy options screen
• Smarter, less confusing caching
  • No more manual caching option—”on the fly” caching is always on now.
• Bugfix: fixed related pages functionality
• Bugfix: an issue with options saving
• Bugfix: a slash escaping bug
• Minor fixes:
  • Fixed yarpp_settings_link dependency when disabled.
  • Breaks (<br />) are now stripped out of titles.
  • Added plugin incompatibility info for Pagebar.
  • Faster post saving.

3.0.13

• Quick immediate bugfix to 3.0.12

3.0.12

• Yet another DISQUS note… sigh.
• Changed default markup to be make the output validate better.
• Reformatted the version log in readme.txt
• Added a Settings link to the plugins page
• Some initial WPML support:
  • Tweaked a SQL query so that it was WPML compatible
  • Added YARPP template to be used with WPML
• Added Hebrew localization

3.0.11

• Quick fix for compare_version code.

3.0.10

• Added Ukrainian localization
• Incorporated a quick update for the widget display thanks to doodlebee.
• Now properly uses compare_version in lieu of old hacky versioning.

3.0.9

• Added Uzbek, Greek, Cypriot Greek, and Vietnamese localizations
• Further bugfixes for the pagination issue

3.0.8

• Bugfix: a pagination issue (may not be completely fixed yet)
• Bugfix: a quick bugfix for widgets, thanks to Chris Northwood
• Added Korean and Lithuanian localizations
• Bugfix: when ad-hoc caching was off, the cached status would always say “0% cached”
• Bugfix: enabled Polish and Italian stopwords and fixed encoding of Italian stopwords.
• Bugfix: is_single and other such flags are now set properly within the related posts Loop (as a result, now compatible with WP Greet Box)
• Confirmed compatibility with 2.8.2
• Bugfix: the Related Posts metabox now respects the Screen Options

3.0.7

• Bugfix: additional bugfix for widgets.
• Reinstating excerpt length by number of words (was switched to letters in 3.0.6 without accompanying documentation)
• Localizations:
  • Updated Italian
  • Added Belarussian by Fat Cow
• Confirmed compatibility with 2.8.1

3.0.6

• Bugfix: updated excerpting to use wp_html_excerpt (for WP 2.5+)
• Bugfix: fixed broken widget display
• Added Russian (ru_RU) localization by Marat Latypov
• Confirmed 2.8 compatibility
• Added note on incompatibility with SEO Pager plugin

3.0.5

• Added link to manual SQL setup information by request
• Added Portuguese localization
• Updated info on “on the fly” caching – it is strongly recommended for larger blogs.
• Updated “incomplete cache” warning message so it is only displayed when the “on the fly” option is off.

3.0.4

• A fix to the version checking in the options page – now uses Snoopy
• Adding Dutch localization

3.0.3

• Reinstated the 3.0.1 bugfix for includes
• Bugfix: Fixed encoding issue in keyword caching algorithm
• Bugfix: One SQL query assumed wp_ prefix on tables
• Added Polish localization
• Added note on DISQUS in readme
• Making some extra strings localizable
• Bugfix: a problem with the Italian localization

3.0.2

• Bugfix: Templating wasn’t working with child templates.
• Bugfix: In some situations, SQL errors were printed in the AJAX preview displays.

3.0.1

• Bugfix: In some situations before YARPP options were updated, an include PHP error was displayed.

3.0

• Major new release!
• Caching for better SQL performance
• A new templating feature for custom related posts displays
• Cleaned up options page
• New and updated localizations

2.1.6

• Versioning bugfix – same as 2.1.5

2.1.5

• Bugfix: In certain scenarios, related posts would be displayed in RSS feeds even when that option was off
• Bugfix: The related_*() functions were missing the echo parameter
• Some localization bugfixes
• Localizations:
  • Japanese (ja) by Michael Yoshitaka Erlewine

2.1.4

• Bugfix: Settings’ sumbmit button took you to PayPal
• Bugfix: Fixed keyword algorithm for users without mbstring
• Bugfix: title attributes were not properly escaped
• Bugfix: keywords did not filter tags. (This bugfix may vastly improve “relatedness” on some blogs.)
• Localizations:
  • Simplified Chinese (zh_CN) by Jor Wang (mail at jorwang dot com) of jorwang.com
  • German (de_DE) by Michael Kalina of 3th.be
• The “show excerpt” option now shows the first n words of the excerpt, rather than the content (by request)
• Added an echo parameter to the related_*() functions, with default value of true. If false, the function will simply return the output.
• Added support for the AllWebMenus Pro plugin
• Further internationalization:
  • the donate button! ^^
  • overused words lists (by request)), with a German word list.

2.1.3

• Bugfix: Turned off the experimental caching which shouldn’t have been on in this release…
• Bugfix: an issue with the keywords algorithm for non-ASCII characters

2.1.2

• Bugfix: MyISAM override handling bug

2.1.1

• Bugfix: keywords with forward slashes () could make the main SQL query ill-formed.
• Bugfix: Added an override option for the false MyISAM warnings.
• Preparing for localization! (See note at the bottom of the FAQ.)
• Adding a debug mode–just try adding &yarpp_debug=1 to your URL’s and look at the HTML source.

2.1 – The RSS edition!

• RSS feed support!: the option to automagically show related posts in RSS feeds and to customize their display, by popular request.
• A link to the Yet Another Related Posts Plugin RSS feed.
• Further optimization of the main SQL query in cases where not all of the match criteria (title, body, tags, categories) are chosen.
• A new format for pushing arguments to the related_posts() functions.
• Bugfix: compatibility with the dzoneZ-Et and reddZ-Et plugins.
• Bugfix: related_*_exist() functions produced invalid queries
• A warning for wp_posts with non-MyISAM engines and semi-compatibility with non-MyISAM setups.
• Bugfix: a better notice for users of WordPress < 2.5 regarding the “compare tags” and “compare categories” features.

2.0.6

• A quick emergency bugfix (In one instance, assumed existence of wp_posts)

2.0.5

• Further optimized algorithm – should be faster on most systems. Good bye subqueries!
• Bugfix: restored MySQL 4.0 support
• Bugfix: widgets required the “auto display” option
• Bugfix: sometimes default values were not set properly on (re)activation
• Bugfix: quotes in HTML tag options would get escaped
• Bugfix: user_level was being checked in a deprecated manner
• A helpful little tooltip for the admin-only threshold display

2.0.4 – what 2.0 should have been

• Bugfix: new fulltext query for MySQL 5 compatibility
• Bugfix: updated apply_filters to work with WP 2.6

2.0.3

• Bugfix: 2.0.2 accidentally required some tags or categories to be disabled

2.0.2

• Versioning bugfix (rerelease of 2.0.1)

2.0.1

• Bugfix: admin_menu instead of admin_head
• Bugfix: a variable scope issue crucial for 2.0 upgrading

2.0

• New algorithm which considers tags and categories, by frequent request
• Order by score, date, or title, by request
• Excluding certain tags or categories, by request
• Sample output displayed in the options screen
• Bugfix: an excerpt length bug
• Bugfix: now compatible with the following plugins:
  • diggZEt
  • WP-Syntax
  • Viper’s Video Quicktags
  • WP-CodeBox
  • WP shortcodes

1.5.1

• Bugfix: standardized directory references to yet-another-related-posts-plugin

1.5

• Simple installation: automatic display of a basic related posts install
• code and variable cleanup
• FAQ in the documentation

1.1

• Related pages support!
• Also, uses apply_filters to apply whatever content text transformation you use (Wikipedia link, Markdown, etc.) before computing similarity.

1.0.1

• Bugfix: 1.0 assumed you had Markdown installed

1.0

• Initial upload