Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tomodomoco/vpm-related-posts

Simple WordPress related posts for developers
https://github.com/tomodomoco/vpm-related-posts

Last synced: 9 days ago
JSON representation

Simple WordPress related posts for developers

Host: GitHub
URL: https://github.com/tomodomoco/vpm-related-posts
Owner: TomodomoCo
Created: 2015-08-05T14:19:25.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2015-10-30T08:47:04.000Z (about 9 years ago)
Last Synced: 2024-04-14T23:59:30.919Z (7 months ago)
Language: PHP
Size: 141 KB
Stars: 2
Watchers: 5
Forks: 0
Open Issues: 6
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# VPM Related Posts

**VPM Related Posts** is a WordPress plugin for simple, no-frills related posts. Pass an ID and get a set of related posts. It's that easy.

A few caveats/tidbits you should be aware of:

+ Related posts are cached as transients for 48 hours (by default).
+ Relations are calculated using MySQL regexp, to prevent needing to reindex your post content as MySQL FULLTEXT. This means results are likely to be—at best—mediocre. MySQL wizards are welcomed to submit pull requests that improve this functionality; my attempt is a quick hack.
+ Due to the use of namespaces, PHP 5.3 is **required**.
+ Because it's developer oriented, this plugin will _probably_ never make it into the WordPress Repository. I suggest using Composer to add this dependency to your project.

## Usage

The namespaced function `\VanPattenMedia\relatedPosts()` will return an array of posts.

It accepts two parameters:

1. `$postId` (int) (Required) - The ID of the post to get related content for
2. `$returnObjects` (bool) (Optional; default: `true`) - Set to `true` (or leave unset) for an array of `WP_Post` objects, or false for an array of post IDs (ideal for using as the `post__in` value in a `WP_Query` call)

### Example

```php
';

foreach( $relatedPosts as $relatedPost ) {
echo '

' . $relatedPost->post_title . '

';
}

echo '';
}
```

## Filters

There are a number of filters provided to make it easier to adjust the query and results.

Filter Name | Type | Description
----------------------------------------|--------|-------------------------------------------------------------------------------------
`vpm_related_posts_stopwords` | array | An array of stopwords that will be filtered from all searches
`vpm_related_posts_contentprepared` | string | A tag-stripped, lower-cased version of your content, before filtering stopwords
`vpm_related_posts_regexfilter` | string | The regex that will be passed into `preg_replace` to filter unneeded text/characters
`vpm_related_posts_keywordthreshold` | int | If the list of keywords used multiple times meets this threshold, use those keywords
`vpm_related_posts_searchregexp` | string | The regexp we'll pass to `$wpdb->prepare` to get our list of related posts
`vpm_related_posts_searchcount` | int | An int of the number of posts to return. Default is 5
`vpm_related_posts_wpdbquery` | string | The full query that will be passed into `$wpdb->prepare`
`vpm_related_posts_transientexpiration` | int | The transient expiration time in seconds. Default is 2 days/172800 seconds

## Changelog

### 1.2.0
+ Added a `$returnObjects` parameter to select between returning an array of `WP_Post` objects or an array of post IDs (true, the default, returns objects; false returns IDs)

### 1.1.0
+ Refined the keyword filter to remove empty values
+ Add method to only return keywords that are mentioned multiple times in the content
+ Run the search based on keywords with multiple uses if the number of those keywords meets a filterable threshold

### 1.0.0
+ Initial commit

## License

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
* Neither the name of the organization nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.