Easy Plugin Stats

FAQ

How do I use the Plugin Stat block?

Search for “Plugin Stat” in the block inserter and add it to a post just like you would any other block. In the inspector, enter the plugin slug and choose the stat you wish to display.

The slug can be retrieved from the plugin’s URL on WordPress.org. For example, this plugin’s slug is easy-plugin-stats.

How do I use the Plugin Button variation for the Button block?

Insert a WordPress Buttons block, then click on the + inserter or open the block inserter. Besides the default Button block, you’ll see the Plugin Button variation. Insert the Plugin Button into the Buttons block. In the inspector, enter the plugin slug and choose the link you wish to connect to the button.

The slug can be retrieved from the plugin’s URL on WordPress.org. For example, this plugin’s slug is easy-plugin-stats.

How do I use the shortcode?

Below is the base shortcode structure with defaults. Technically, slug is the only required field. If you enter your plugin’s slug and place the shortcode in a post or template, it will display the number of active installs and cache the data for 43200 seconds (12 hours).

`

[eps type=”single” slug=”your-plugin-slug” field=”active_installs” cache=”43200″ before=”” after=””]
`

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 slug which can be retrieved from the plugin’s 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 fields. 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
• contributors – Contributors
• tags – Tags
• requires – Requires
• tested – Tested
• num_ratings – Number of reviews
• rating – Rating out of 100
• five_rating – Rating out of 5
• star_rating – Star rating
• last_updated – Last updated
• added – Date added
• homepage_link – Plugin homepage link
• download_link – Download link
• live_preview_link – Live preview link
• support_link – Support forum link
• reviews_link – Reviews link
• author_profile – Author profile link
• donate_link – Donate link
• description – Description
• installation – Installation
• screenshots – Screenshots
• changelog – Changelog
• faq – FAQ

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 the 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 the required shortcode markup. Defaults to null.