Easy Plugin Stats

Overview

Disclaimer: This plugin is geared towards developers with plugins in the WordPress.org repository and anyone else that wants to easily display information about a plugin that is in the repository. Don’t fit this criteria? Then this plugin will probably not be of much use to you.

This plugin was designed to be as simple as possible, while still being very powerful. There is no settings page, just one shortcode and TinyMCE shortcode interface to help you generate codes with ease. You can display stats from a single plugin, or aggregate stats from multiple plugins. Check out the video below for a quick overview.

Usage

Standard Method

The easiest way is to click the new plugin stat icon that is added to the top bar of your WordPress editor (Check out the screenshots below). It looks like the standard WordPress plugin icon. This will launch a popup window where you can then choose your settings and enter in the desired plugin slug(s). Click insert, and the generated shortcode will be added to your editor’s content field.

Manual Method

If you don’t want to bother with the popup window, or what to use the shortcode outside the editor, you can manually type out the shortcode. Below is the base shortcode structure with defaults. Technically, slug is the only required field. If you just enter your plugin’s slug, the shortcode will display the number of active installs and cache the data for 43200 seconds (i.e. 12 hours).

type

Optional. The type of stat you with to display, either a stat from a single plugin or an aggregate stat generated from multiple plugins. Accepts single or aggregate. Defaults to single.

slug

Required. This is the plugin slug which can be retrieved from the plugin url on WordPress.org. For example, this plugin’s slug is easy-plugin-stats. Accepts any valid plugin slug for single, or any number of space-separated plugin slugs when using aggregate. Defaults to null.

field

Optional. The name of the field you have chosen to display. Accepts any of the following field. Defaults to active_installs.

The available stat fields for single are:

  • active_installs (Active Installs)
  • downloaded (Times Downloaded)
  • name (Plugin Name)
  • slug (Plugin Slug)
  • version (Version)
  • author (Author)
  • author_profile (Author Profile Link)
  • contributors (Contributors)
  • requires (Requires)
  • tested (Tested)
  • rating (Rating out of 100)
  • five_rating (Rating out of 5)
  • star_rating (Star Rating)
  • num_ratings (Number of Reviews)
  • last_updated (Last Updated)
  • added (Date Added)
  • homepage (Plugin Homepage Link)
  • short_description (Short Description)
  • description (Description)
  • installation (Installation)
  • screenshots (Screenshots)
  • changelog (Change Log)
  • faq (FAQ)
  • download_link (Download Link)
  • support_link (Support Link)
  • tags (Tags)
  • donate_link (Donate Link)

The available stat fields for aggregate are:

  • active_installs (Active Installs)
  • downloaded (Times Downloaded)

cache

Optional. The shortcode requests your plugin’s stats from WordPress.org. To limit the number of requests made, response data is cached. This optional setting allows you to adjust the cache time as you see fit. Accepts any positive integer (representing seconds) greater than 5. Defaults to 43200 (i.e. 12 hours).

before

Optional. Optional HTML to be printed before the field’s output. Accepts any valid HTML, but note that all double quotes will be replaced with single quotes to adhere to required shortcode markup. Defaults to null.

after

Optional. Optional HTML to be printed after the field’s output. Accepts any valid HTML, but note that all double quotes will be replaced with single quotes to adhere to required shortcode markup. Defaults to null.

Screenshots

Demos

Single Stats

This entire page is actually a demo for single stats. The stats in the sidebar, the tagline description at the top of the page, the installation instructions and changelog are all generated using the plugin. Here is the markup:

Aggregate Stats

Currently, there are only two aggregate options available: active_installs and downloaded. A good example of an aggregate stat is on the homepage of this website where I display the total active installs and times downloaded of all my plugins on WordPress.org. The only real difference between the shortcode markup for aggregate and single stats is the inclusion of type="aggregate":

This generates:

…WordPress community. My code is currently running on 35,000+ websites and has been downloaded 307,877 times…

Installation

  1. You have a couple options:
    • Go to Plugins->Add New and search for “Easy Plugin Stats”. Once found, click “Install”.
    • Download the folder from WordPress.org and zip the folder. Then upload via Plugins->Add New->Upload.
  2. Activate the plugin through the ‘Plugins’ menu in WordPress.
  3. From the ‘Plugins’ page, head to a post/page and check out the new button in your editor.
  4. If you have any implementation questions, please post in the plugin support forum.

Support

Do you need additional help with Easy Plugin Stats? Head on over to the plugin support forums on WordPress.org. I monitor the forums constantly and it is likely that there are others with your same question. Keeping all questions and answers over there will help everyone. If you contact me directly through this website about Easy Plugin Stats, I will just kindly direct you over to WordPress.org 😉.

Changelog

1.0.0

  • Initial Release