10up/curator

Name: curator

Owner: 10up

Description: Select specific posts from across multiple post types to combine together and control the ordering.

Created: 2014-10-16 21:45:59.0

Updated: 2018-01-11 07:20:34.0

Pushed: 2016-02-25 18:22:20.0

Homepage: null

Size: 1613

Language: PHP

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Curator

Select specific posts from across multiple post types to combine together and control the ordering.

Background & Purpose

If you've ever needed to create a query that pulls in multiple post types, posts and post formats but still allow for the control of the order of those items, you'll find WordPress falls a bit short.

Curator let's you specify which post types should be curated and then provides an interface for ordering those.

Requirements

For this plugin to be effective it should be paired with the Simple Page Ordering plugin. This will create an easy to use ordering/sorting system for your curated items.

Configuration

Specify which post types should be curated using the filter `cur_set_post_types`.

For example, in your theme or plugin you can add the following filter:

dd our post types to include in the curator plugin
filter( 'cur_set_post_types', function( $post_types ) {
return array(
    'post',
    'page',
    'custom-post-type-slug',
);

In addition to allowing items to be curated, Curator also comes with two additional modules: Featurer and Pinner. These are disabled by default. To enable these two features, use the `cur_modules` filter to pass which modules should be enabled/disabled:

nable curation, featuring, and pinning of items in the curation plugin
filter( 'cur_modules', function( $modules ) {
$modules['curator']['enabled'] = true;
$modules['featurer']['enabled'] = true;
$modules['pinner']['enabled'] = true;

return $modules;

Usage

Curating

When editing a post, you will see the option to 'Curate Item' in the publish box. To curate an item, simply check that box and it will be curated after saving of the current post.

To manage the order of the curated items, click on the `Curator` menu icon:

To re-arrange items, ensure that you have already installed the Simple Page Ordering plugin and simply drag and drop items.

Uncurating

To uncurate an item, simply uncheck the Curate Item checkbox in the original post, or click Trash in the curator.

Querying

Curator works seamlessly to provide a full WP_Query object of original post objects regardless of their post type of origin. Simply pass `cur-curatoras the ``post_type``` parameter for a WP_Query.

s = array(
'post_type' => 'cur-curator',


ated_posts = new WP_Query( $args );

Load up your loop and interact with the posts normally:

 $curated_posts->have_posts() ) : while ( $curated_posts->have_posts() ) : $curated_posts->the_post();

// Use normal WP methods for retrieving post content, meta, etc
the_title();

the_content();
hile; endif;

Helper Functions

You can use the function `cur_is_featured()` either within the loop or outside of the loop (if you pass it a post's ID) to determine if the curated post is featured or not.

Please ensure that you've enabled the featurer module first before attempting to use it, or you will not be able to feature any items or detect if items are featured.

s = array(
'post_type' => 'cur-curator',


ated_posts = new WP_Query( $args );

 $curated_posts->have_posts() ) : while ( $curated_posts->have_posts() ) : $curated_posts->the_post();

// Set our default to not be featured
$featured = false;

// Ensure this function exists, if you don't wrap the function call and then deactivate the plugin you will cause a fatal error in your installation
if ( function_exists( `cur_is_featured` ) ) {
    $featured = cur_is_featured();
}

hile; endif;