.is_active(id, version)

The is_active function can be used to detect if a plugin is installed, and whether it matches a specific version. This function should be used in conjunction with bits soft-requirements system to block parts of your plugin to users who may not have all the required plugins.

The version paramater is optional and can be ommitted.

plugins.is_active(id, version)

Example with Bit: Core 2025.2.0 installed

const reqMet = plugins.is_active('bit-core', '2025.2.0');

console.log(reqMet)

// Output if everything matches
/*
{
    "installed": true,
    "activated": true,
    "match_version": true
}
*/

// Output if Bit: Core is not installed
/*
{
    "installed": false,
    "activated": null,
    "match_version": null
}
*/

// Output if Bit: Core is installed but not on the right version.
/*
{
    "installed": true,
    "activated": true,
    "match_version": false
}
*/

// Output if Bit: COre is installed but disabled
/*
{
    "installed": true,
    "activated": false,
    "match_version": null
}
*/

Last updated

Was this helpful?