humanmade/related-posts

Extensible related posts wrapper with support for manual overrides.

Installs: 3 549

Dependents: 0

Suggesters: 0

Security: 0

Stars: 12

Watchers: 4

Forks: 2

Open Issues: 5

Type:wordpress-plugin

1.2.2 2019-01-22 18:17 UTC

This package is auto-updated.

Last update: 2021-05-23 00:13:00 UTC


README

This plugin provides a simple related posts function with the following features:

  • ElasticPress integration (uses a "More Like This" query)
  • Admin UI for manually overriding related posts

Installation

composer require humanmade/related-posts

Usage

The plugin exposes a single function that returns a list of post IDs.

HM\Related_Posts\get( int $post_id, array $args = [] )

$post_id is the ID of the post to get related content for.

$args allows you some control over the posts that are returned:

  • int limit: defaults to 10
  • array post_types: array of post types to limit results to. Defaults to [ 'post' ]
  • array taxonomies: array of taxonomies to compare against. Defaults to [ 'category' ]
  • array terms: array of WP_Term objects, results will match these terms
  • array terms_not_in: array of WP_Term objects, results will not match these terms
  • bool ep_integrate: if true then ElasticPress is used to get the results, Defaults to defined( 'EP_VERSION' )

Custom post type support

To add related posts support to your custom post type simply declare the following:

add_post_type_support( 'your-custom-post-type', 'hm-related-posts' );

In addition to fine control the post types that have related posts support you can use the hm_rp_post_types filter.

add_filter( 'hm_rp_post_types', function ( $post_types ) {
    // your code goes in here

    return $post_types;
} );

Made with ❤️ by Human Made