https://github.com/helgatheviking/featured-item-metabox

Creates a metabox for featured items on any post type you specify. Also adds sortable columns and quick edit ability.
https://github.com/helgatheviking/featured-item-metabox

Last synced: about 7 hours ago
JSON representation

Creates a metabox for featured items on any post type you specify. Also adds sortable columns and quick edit ability.

• Host: GitHub
• URL: https://github.com/helgatheviking/featured-item-metabox
• Owner: helgatheviking
• Created: 2013-01-24T20:05:38.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2020-02-17T23:45:36.000Z (over 4 years ago)
• Last Synced: 2024-04-09T21:18:32.784Z (7 months ago)
• Language: PHP
• Size: 151 KB
• Stars: 8
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Featured Item Metabox #

**Contributors:** [helgatheviking](https://profiles.wordpress.org/helgatheviking)  

**Donate link:** https://www.paypal.com/fundraiser/112574644767835624/charity/1451316  

**Tags:** metabox, featured  

**Requires at least:** 3.8  

**Tested up to:** 5.3.2   

**Stable tag:** 1.4.0  

**License:** GPLv3 or later  

**License URI:** http://www.gnu.org/licenses/gpl-3.0.html  

Quickly add a metabox to any post type for marking a post as featured.  Toggle featured status even more quickly from the posts lists/ quick edit screen.

## Description ##

I found I constantly needed a way for clients to mark a post as something they wanted to feature and I've never found sticky posts particularly inuitive and the UI is pretty hidden for new users.  The simplest solution was a checkbox in prominently located metabox.

Please note that this plugin, by itself, will not change how your posts are displayed.  It just gives the UI to users and a meta key to theme developers to query for.

### Usage ###

This plugin simply adds a `_featured` meta key to every post with a value of `yes` for featured items and `no` for everything else.  Actual display of the featured items is entirely up to the theme developer, but an example ( place in your template where you'd like to display a list of featured "Portfolios") might be as follows:

	// params for our query

	$args = array(

		'post_type' => 'portfolio',

	   'posts_per_page'  => 5,

	   'meta_key'        => '_featured',

	   'meta_value'      => 'yes'

	);

	

	// The Query

	$featured_portfolios = new WP_Query( $args );

	

	// The Loop

	if ( $featured_portfolios ) :

	

		echo '
';

	

		while ( $featured_portfolios->have_posts() ) :

			$featured_portfolios->the_post();

			echo '
' . get_the_title() . '
';

		endwhile;

	

		echo '
';

	

	else :

	

		echo 'No featured portfolios found.';

	

	endif;

	

	/* Restore original Post Data

	 * NB: Because we are using new WP_Query we aren't stomping on the

	 * original $wp_query and it does not need to be reset.

	*/

	wp_reset_postdata();


Multiple queries per page load can slow down your site so it is worthwhile to take advantage of the [Transients API](http://codex.wordpress.org/Transients_API), so an alternate usage would be:

	// Get any existing copy of our transient data

	if ( false === ( $featured_portfolios = get_transient( 'featured_portfolios' ) ) ) {

	    // It wasn't there, so regenerate the data and save the transient

	

	   // params for our query

		$args = array(

			'post_type' => 'portfolio',

		   'posts_per_page'  => 5,

		   'meta_key'        => '_featured',

		   'meta_value'      => 'yes'

		);

	

		// The Query

		$featured_portfolios = new WP_Query( $args );

	

		// store the transient

		set_transient( 'featured_portfolios', $featured_portfolios );

	

	}

	

	// Use the data like you would have normally...

	

	// The Loop

	if ( $featured_portfolios ) :

	

		echo '
';

	

		while ( $featured_portfolios->have_posts() ) :

			$featured_portfolios->the_post();

			echo '
' . get_the_title() . '
';

		endwhile;

	

		echo '
';

	

	else :

	

		echo 'No featured portfolios found.';

	

	endif;

	

	/* Restore original Post Data

	 * NB: Because we are using new WP_Query we aren't stomping on the

	 * original $wp_query and it does not need to be reset.

	*/

	wp_reset_postdata();


Then to ensure that your featured posts list is updated, add a function to your theme's functions.php to delete the transient when a portfolio (in this example) post type is saved.

	// Create a function to delete our transient when a portfolio post is saved

	function save_post_delete_featured_transient( $post_id ) {

	   if ( 'portfolio' == get_post_type( $post_id ) )

	   	delete_transient( 'featured_portfolios' );

	}

	// Add the function to the save_post hook so it runs when posts are saved

	add_action( 'save_post', 'save_post_delete_featured_transient' );

Simple queries should only need the `meta_key` and `meta_value` parameters, but if you need something more advanced then you might want to read about how to use the more [complex Meta Query parameters](http://scribu.net/wordpress/advanced-metadata-queries.html).

### Support ###

Support is handled in the [WordPress forums](http://wordpress.org/support/plugin/featured-item-metabox).  Please note that support is limited and does not cover any custom implementation of the plugin. 

Please report any bugs, errors, warnings, code problems at [Github](https://github.com/helgatheviking/Featured-Item-Metabox/issues)

## Installation ##

1. Upload the `plugin` folder to the `/wp-content/plugins/` directory

2. Activate the plugin through the 'Plugins' menu in WordPress

3. Go to the plugin's settings and select which post types for which you'd like to show the featured metabox

## Screenshots ##

1. The plugin settings

2. Posts overview. Featured status can be changed via quickedit, or by simply clicking on the star icon.  Dark stars are featured whereas hollow stars are not.

3. The metabox when editing an individual post

## Changelog ##

### 1.4.0 ###

* Gutenberg compatibility

### 1.3.2 ###

* fixes bug where toggle script wasn't loading if "remove all" plugin option was checked

### 1.3.1 ###

* fixes problem of quick edit not adjusting to toggle

### 1.3.0 ###

* testing against WP4.4

* on posts overview page, use ajax to toggle featured on/off

* replace star images with dashicons

### 1.2.4 ###

* testing against WP4.3

* improved code formatting

### 1.2.3 ###

* add featured_items_metabox_label filter

* add featured_items_checkbox_label filter

### 1.2.2 ###

* make plugin work on media attachments

### 1.2.1 ###

* Fixing file rename

### 1.2 ###

* switching to singular instance of plugin, to prevent the need to use globals (global still there for backcompat)

* don't show private post types as possibilities in options 

* update documentaion

* update docbloc

### 1.1.4 ###

* verify WP 3.8 compatibility

### 1.1.3 ###

* fix more warnings. props @pushka

### 1.1.2 ###

* php strict standards for static variables

### 1.1.1 ###

* update FAQ

### 1.1 ###

* fix whitescreen bug on ajax action for edit columns

### 1.0.1 ###

* fix markdown for changelog

### 1.0 ###

* Initial release.