xxsimoxx/stats-for-update-manager

Add statistics to Update Manager ClassicPress plugin.

Discover how many sites are using your plugins and themes!

This is a companion plugin for Update Manager.

With Stats for Update Manager you can count active installations of your plugins and themes that serve updates with Update Manager.

You'll find a new submenu, Statistics, under the Update Manager menu.

It's compatible with Update Manager versions 1.x and 2.x.

It supports WP-CLI. See the help typing:

• wp help statistics show
• wp help statistics purge
• wp help statistics delete

When a plugin/theme is in that count

Plugins and themes that queried Update Manager at least once in the last week are considered active. When a plugin/theme have not queried Update Manager in the last 4 week it's removed from the database table. See filters section to tweak.

It also add the number of active installations in the plugin details. See filters section to tweak.

You can reset the count using the Reset row action.

Disclaimers

This plugin is intended to be used by developers.

Filters

Change/hide the number of active installations in plugin info tab

sfum_active_installations let's you change/hide the number displayed in the details of your plugins.

Examples:

add_filter('sfum_active_installations', 'example_filter');

Don't show active installation for my nothing-to-see plugin and raise it to one million for boost!

	function example_filter($ar){
		unset ($ar['nothing-to-see/nothing-to-see.php']);
		$ar['boost/boost.php'] = 1000000;
		return $ar;
	}

Or simply disable it all

	function example_filter($ar){
		return [];
	}

Note: the real number is cached for 6 hours.

Add opt-in or opt-out for your plugin users

Supported by Update Manager Client since 2.3.0. Note: this filter is from Update Manager, not from Stats for Update Manager. codepotent_update_manager_filter_{$slug}_client_request let's you inject data in the request made by UpdateClient.class.php.

Example:

add_filter('codepotent_update_manager_filter_my-slug/my-slug.php_client_request', 'example_filter');

function example_filter($body){
	if( 'no' === get_option( 'my-slug-usage-statistics' ) ) {
		$body['sfum'] = 'no-log';
	}
	return $body;
}

Recognize your own sites in debug

Note that debug information is displayed only if WP_DEBUG is set to true.

sfum_my_sites let's you recognize your own sites. They will be marked with an * in the debug informations. With this filter you can populate an array of sha512-hashed urls. Example:

add_filter('sfum_my_sites', 'all_my_sites');

function all_my_sites($sha) {
	$mysites = [
		'https://my-first-site.dog',
		'https://www.my-second-site.dog'
		];

	$myhashes = array_map(function($value){
		return hash('sha512', $value);
	}, $mysites);

	return $myhashes;
}

Configure the timing a plugin/theme is considered active or stale

sfum_inactive_after let's you configure the number of days before a plugin/theme installation is considered inactive.

sfum_old_after let's you configure the number of days before a plugin/theme installation is considered stale and will be removed from the database.

Example:

// An entry is old after 2 days and will be removed after 7
add_filter('sfum_inactive_after', 'return_two');
add_filter('sfum_old_after', 'return_seven');

function return_two($days) {
	return 2;
}
function return_seven($days) {
	return 7;
}

Note that filtering sfum_old_after to 0 will erase your database when the daily maintenence cronjob is executed.

Prevent specific(s) plugin(s)/theme(s) to be logged

sfum_exclude let's you configure an array of identifier that are excluded from logging.

Note: this don't clean your database from already logged ones.

Example:

// Don't log those plugins
add_filter('sfum_exclude', 'no_log_please');

function no_log_please($list) {
	$excluded = [
		'please-dont/log-me.php',
		'excluded-plugin/excluded-plugin.php',
		'my-theme-slug'
	];
	return $excluded;
}

Shortcodes

[sfum-installs]

The above shortcode returns an integer depicting the total number of all installations (of all plugins and themes) across the web. Developers can use it in a sentence:

Our plugins have [n] active installations!

[sfum-installs id="my-plugin-folder/my-plugin-file.php"]

Building on the previous example, you can also provide a plugin or theme id. This shortcode returns an integer depicting the total number of installs for the plugin or theme with the given identifier. Developers can use it in a sentence:

My Awesome Plugin has [n] active installations!

My Amazing Theme has [n] active installations!

[sfum-domains]

This shortcode returns an integer depicting the number of unique domains using all of the developer's plugins. Developers can use it in a sentence:

Code Potent is running on [n] sites!

REST API

To get a list of endpoint identifier and active installations you can access wp-json/stats/v1/stats/. To enable this, add to wp-config.php this line:

define( 'SFUM_ENABLE_REST', true );

Note that the value of active installation is affected by the filter sfum_active_installations.

GDPR / privacy

This plugin stores data about plugin/theme updates in a table. You can configure how much time this data is kept using sfum_old_after filter (defaults to 4 weeks). All the data is removed at plugin uninstall.

• URL of the site asking for updates, sha512 hashed
• plugin/theme checked
• timestamp of the last check

Is up to you to decide if and to inform your plugin/theme users that this data is kept.

To help us know the number of active installations of this (Stats for Update Manager) plugin, we collect and store anonymized data when the plugin check in for updates. The date and unique plugin identifier are stored as plain text and the requesting URL is stored as a non-reversible hashed value. This data is stored for up to 28 days.

To skip Stats for Update Manager from logging, the plugin/theme have to ask for updates defining, in the body of the request done by UpdateClient, $body['sfum']='no-log'. Since version 2.3.0 of Update Manager client this can be done using a filter.

Screenshot