Plugin Cards

With Plugin Cards you can easily display a custom list of plugins for any purpose.

Usage

This plugin adds a shortcode [plugin_cards] that you can use to display the plugin cards anywhere on your site.

The following parameters can be used to create your query:

[plugin_cards slug="easy-digital-downloads"] [plugin_cards author="markjaquith"] [plugin_cards user="matt"] // Displays user's favorites list [plugin_cards tag="slider"] [plugin_cards browse="popular"] [plugin_cards browse="new"] [plugin_cards browse="beta"] [plugin_cards search="gallery"]

Note: The wordpress.org API only supports querying by one parameter at a time, so currently only one parameter can be included in the shortcode to build the query. If this ever changes I will add support for querying by multiple parameters to this plugin.

Note: The parameter is required for the shortcode to work. Simply using [plugin_cards] will result in a silent fail.

You can also set the max number of results using the max_results parameter like this:

[plugin_cards max_results="10" browse="popular"]

Advanced Usage

This plugin includes a number of filters that you can use to customize the display of the cards and add plugin information to the cards. I recommend reading through the code if you really want to understand how the filters can be used. Here are some examples:

Use a custom query

function custom_plugin_cards_query( $custom_query_args, $atts = array(), $fields = array() ) { // Show the 10 most popular plugins with only certain fields returned $custom_query_args = array( 'per_page' => 10, 'browse' => 'popular', 'fields' => array( 'banners' => true, 'icons' => false, 'reviews' => true, 'rating' => true, 'num_ratings' => true, 'downloaded' => false, 'active_installs' => false, 'short_description' => false, 'sections' => true, 'downloadlink' => true, 'last_updated' => true, 'homepage' => true, ) ); return $custom_query_args; } add_filter( 'plugin_cards_api_query_args', 'custom_plugin_cards_query', 10, 3 );

Then you’d have to use one of the output filters and some CSS to get the new fields to show on the page. There is a lot that is possible with the plugin_cards_api_query_args filter, too much to cover here, but the key is setting the right main query param and setting the fields that you want returned.

Use custom URLs

function custom_plugin_card_urls( $plugin_url, $plugin = null ) { // Point URLs to a custom endpoint based on the plugin slug $plugin_url = 'https://domain.com/custom-plugins/' . esc_attr( $plugin->slug ); // Change the URL of a specific plugin if ( 'woocommerce' === $plugin->slug ) { $plugin_url = 'http://www.woothemes.com/woocommerce/'; } return $plugin_url; } add_filter( 'plugin_cards_plugin_url', 'custom_plugin_card_urls', 10, 2 );

The complete list of simple filters that work exactly like plugin_cards_plugin_urls is:

plugin_cards_plugin_url plugin_cards_plugin_name plugin_cards_short_description plugin_cards_plugin_author

There are also some advanced filters that allow you to override the HTML output of entire sections, including:

plugin_cards_plugin_icon plugin_cards_action_links plugin_cards_plugin_rating plugin_cards_last_updated plugin_cards_install_count plugin_cards_plugin_compatibility

These filters can be used like this:

Use custom plugin icons

function custom_plugin_card_icons( $plugin_icon, $plugin = null, $plugin_url = '' ) { // Replace all plugin icons with kittens $plugin_icon = '<a href="' . esc_url( $plugin_url ) . '" class="plugin-icon"><img src="http://domain.com/kittens.jpg" /></a>'; // Replace the icon for a specific plugin if ( 'equal-height-columns' === $plugin->slug ) { $plugin_icon = '<a href="' . esc_url( $plugin_url ) . '" class="plugin-icon"><img src="http://domain.com/custom-icon.jpg" /></a>'; } return $plugin_icon; } add_filter( 'plugin_cards_plugin_icon', 'custom_plugin_card_icons', 10, 3 );

There is also one special filter plugin_cards_cache_expiration that allows you to set how long you want the results of the API request to be cached. The default is 2 hours (expressed as number of seconds).

If you want a hook added just let me know. Pull requests are welcome on Github .