WP Plugin Repo Stats

1. 

   Plugin settings page

2. 

   Screenshot of plugin in action on my site

What are the plugin defaults?

The plugin arguments and default values may change over time. To get the latest list of arguments and defaults, look at the settings page after installing the plugin.

How do I use the plugin?

Use a shortcode to call the plugin from any page or post like this:

[plugin-repo-stats]

This will:

• fetch the download counts for a given wordpress.org profile ID (which you put in the plugin’s Settings page, right?)
• add rel=”nofollow” to each link
• use rounded corner CSS
• cache the plugin output for one hour (3600 seconds = 60 seconds * 60 minutes * 1 hour)
• include plugin star rating images
• links open in same window

Your wordpress.org profile ID is your login on wordpress.org. You must include this or the plugin will do nothing.

You can also call the plugin in your functions.php, ex:

if (function_exists('wpprs')) {
  wpprs(array('uid' => 'your userid', 'show' => true));
}

Always wrap plugin function calls with a function_exists check so that your site doesn’t go down if the plugin isn’t active.

How can I style the output?

The output contains extensive CSS classes you can target in your style.css. You can style alternating rows and style each table column separately. View the output source to see the table CSS structure, or browse the plugin’s ‘css’ folder. The CSS to duplicate the screenshot is included in the plugin. You will need to override this if you want to see something different.

I inserted the shortcode but don’t see anything on the page.

Clear your browser cache and also clear your cache plugin (if any). If you still don’t see anything, check your webpage source for the following:

<!-- WP Plugin Repo Stats: plugin is disabled. Check Settings page. -->

This means you didn’t pass a necessary setting to the plugin, so it disabled itself. You need to pass at least the wordpress.org userid, either by entering it on the settings page or passing it to the plugin in the shortcode or PHP function. You should also check that the “enabled” checkbox on the plugin settings page is checked. If this box is unchecked, the plugin will do nothing even if you pass your userid.

I changed a setting on the plugin’s settings page but the table still reflects my old settings.

The plugin output is cached (using WP 3.5+ transients) to avoid overtaxing the wordpress.org website with excessive scraping requests. Excessive scraping may result in an IP ban, which would cause denial of service. Wait until the cache expires, then reload the page to view your settings changes.

Even if you specify a very low cache time (ex: 60 seconds), the plugin will only re-fetch content every 5 minutes. Please do not edit the plugin to change this.
Unless the download count is very low, it is highly unlikely that any given plugin is downloaded so often that someone visiting a page after five minutes would actually notice how many more downloads it has.

You might also consider clearing your browser cache and your caching plugin.

I cleared my browser cache and my caching plugin but the output is still old.

Are you using a plugin that minifies CSS? If so, try excluding the plugin CSS file from minification.

I cleared my cache and still don’t see what I want.

The CSS files include a ?ver query parameter. This parameter is incremented with every upgrade in order to bust caches. Make sure none of your plugins or functions are stripping this query parameter. Also, if you are using a CDN, flush it or send an invalidation request for the plugin CSS files so that the edge servers request a new copy of it.

I called the plugin on two different pages with two different cache times, but the cache doesn’t refresh as expected.

The cache is userid-dependent and site-wide. You cannot specify different cache times for the same userid concurrently — the first shortcode or function call that is made on an empty cache will set the cache time. Ideally you are only displaying the output of this plugin once on your site.

The plugin feels slow.

WP Plugin Repo Stats has to visit a given user’s wordpress.org profile page, then (if requested) visit each plugin’s page and parse it for the plugin’s rating. This is time consuming and totally dependent on wordpress.org’s network availability. If a given user has a large amount of plugins in the repo, it could take a relatively significant amount of time to fetch each page. To optimize the plugin’s operation, the star rating is left blank if there is a page error on wordpress.org (no stars).

To speed up the plugin operation, increase the cache time and (if possible) do not request plugin star ratings (uncheck ‘Show plugin ratings?’ on the plugin settings page). The default cache time is 12 hours and I recommend you leave it that way to avoid burdening wordpress.org.

I want to remove the post editor toolbar button.

Add this to your functions.php:

remove_action('admin_print_footer_scripts', 'add_wpprs_quicktag');

I want to remove the admin CSS.

Add this to your functions.php:

remove_action('admin_head', 'insert_wpprs_admin_css');

I don’t want to use the plugin CSS.

Add this to your functions.php:

add_action('wp_enqueue_scripts', 'remove_wpprs_style');
function remove_wpprs_style() {
  wp_deregister_style('wpprs_style');
}

I don’t see the plugin toolbar button(s).

This plugin adds one or more toolbar buttons to the HTML editor. You will not see them on the Visual editor.

The label on the toolbar button is “Plugin Repo Stats”.

How do I show download and rating for only one plugin?

Use the “pluginname” parameter like this:

[plugin-repo-stats pluginname="Name of your plugin"]

This will output a small box with a link to the plugin page on wordpress.org, the date, the download count and the plugin rating (if checked on the plugin settings page).

I am using the shortcode but the parameters aren’t working.

On the plugin settings page, go to the “Parameters” tab. There is a list of possible parameters there along with the default values. Make sure you are spelling the parameters correctly.

The Parameters tab also contains sample shortcode and PHP code.

0.3.1

• updated .pot file and readme

0.3.0

• fixed validation issue

0.2.9

• compressed CSS file

0.2.8

• code fix
• internationalization of dates/times
• admin CSS and page updates

0.2.7

• fixed issue with invalid counts

0.2.6

• updated support tab

0.2.5

• new parameter “pluginname” pass in the name of your plugin and it shows download info for only that plugin
  by request of https://wordpress.org/support/topic/some-more-display-options-please
• code optimizations
• use ‘uid’ or ‘userid’ as the wordpress.org userid parameter name
• default cache time changed to 12 hours (43200 seconds)
• minor code fix

0.2.4

• fix for wp_kses

0.2.3

• some minor code optimizations
• verified compatibility with 3.9

0.2.2

• OK, I am going to stop playing with the plugin now. Version check rolled back (again)

0.2.1

• prepare strings for internationalization
• updated number fields to range for HTML5
• plugin now requires WP 3.5 and PHP 5.0 and above
• minor code optimization

0.2.0

• minor plugin settings page update
• minor code update

0.1.9

• added submit button to the top of the plugin settings page
• spruced up the plugin settings page
• minor CSS changes
• minor bug with parameter table on plugin settings page

0.1.8

• suppress PHP warning with HTML parsing
• removed screen_icon() (deprecated)
• updated for WP 3.8.1

0.1.7

• All CSS and JS automatically busts cache

0.1.6

• refactored admin CSS
• added helpful links on plugin settings page and plugins page

0.1.5

• added dynamic wording if only one plugin available
• added div class wrapped around the “Number of times my WordPress plugins have been downloaded” sentence so it can be hidden via CSS

0.1.4

fixed uninstall routine, actually deletes options now

0.1.3

• updated the plugin settings page list of parameters to indicate whether they are required or not
• updated FAQ section of readme.txt

0.1.2

some security hardening added

0.1.1

minor admin code update

0.1.0

• target=”_blank” is deprecated, replaced with javascript fallback

0.0.9

• minor code refactoring

0.0.8

• minor code refactoring
• added shortcode defaults display on settings page

0.0.7

rollback sanitation

0.0.6

• sanitize some inputs to reduce attack vectors
• added donate link on admin page
• admin page CSS added

0.0.5

• moved quicktag script further down the page
• minor admin page update
• added option to open links in new window
• minor code refactoring
• css file refactoring

0.0.4

• updated admin messages code
• output can be sorted by plugin name either ascending or descending
• updated readme

0.0.3

• added admin menu
• option to exclude star ratings
• added rel=nofollow option
• added quicktag to post editor toolbar

0.0.2

added stars rating, WP logo, changed default cache time to one hour

0.0.1

created