Developer Reference

Scalability Pro exposes a set of PHP constants and one add-on registration filter for developers who need to tune its behaviour beyond what the settings screens offer, or who are building an add-on that plugs into it. This article covers the configuration constants you can define in wp-config.php, how to set them, and how the spro_register_addons filter lets an external plugin register itself and its settings tab.

Every constant listed here is defined with a guard in the plugin’s defines.php, so defining it earlier (in wp-config.php) always wins. Anything not listed here is either internal or not consumed by the current code, so leave it alone.

Configuration constants

Two of these are booleans that are on by default (SPRO_KEEP_DEFER_TERM_COUNTS_OPTION) and off by default (SPRO_CACHE_PMXE_META_KEYS, SPRO_PREVENT_WPAI_DUP_CHECK, both nav-menu constants); the rest are numbers or arrays. Where a constant relates to a feature that has its own settings screen, the constant tunes the underlying behaviour rather than turning the feature on. See Ajax Attribute Editing for SPRO_ATTRIBUTE_AJAX_LIMIT, Defer Term Counting for SPRO_KEEP_DEFER_TERM_COUNTS_OPTION and SPRO_ALWAYS_DO_TERM_RECOUNTS, and Using the Slow Query Log for SPRO_MAX_TRACE_CHARS.

How to set a constant

Define the constant in wp-config.php, above the line that says to stop editing. Because defines.php only defines each constant if it is not already defined, your value takes precedence.

define('SPRO_ATTRIBUTE_AJAX_LIMIT', 25);

define('SPRO_ALWAYS_DO_TERM_RECOUNTS', array(
    'nav_menu',
    'link_category',
    'post_format',
    'product_cat',
));

define('SPRO_SQL_CALC_ROWS_FINGERPRINT', array(
    'my-plugin/includes/class-archive-query.php',
));

Array constants replace the default wholesale, so if you are adding to SPRO_ALWAYS_DO_TERM_RECOUNTS include the existing entries you still want alongside your additions.

Registering an add-on

Scalability Pro can host add-on plugins. An add-on registers through the spro_register_addons filter, which passes an array keyed by add-on slug. Each entry must declare a dir (the add-on’s base directory); the loader then requires tabs/<slug>/functions.php from that directory on plugins_loaded, and, if present, registers tabs/<slug>/tab.php as a settings tab in the Scalability Pro admin page.

The slug is the array key, and it is what forms the tabs/<slug>/ path, so the add-on’s files must live under a folder matching that key. Register during your own plugin’s load so the filter is in place before plugins_loaded priority 10.

if (defined('SPROPLUGIN_DIR')) {
    add_filter('spro_register_addons', function ($addons) {
        $addons['archives'] = array(
            'plugin_file' => __FILE__,
            'dir'         => MY_ADDON_PLUGIN_DIR,
            'version'     => MY_ADDON_VERSION,
            'label'       => 'Archives',
            'tab_slug'    => 'archives',
        );
        return $addons;
    });
}

The loader uses require_once, so an add-on that also registers with another parent (Super Speedy Filters has an equivalent loader) will not redeclare its functions when both parents resolve to the same file. Super Speedy Archives is the reference add-on and registers exactly as shown above under the archives slug; see the Super Speedy Archives Add-on for the working example.

Guarding the registration with defined('SPROPLUGIN_DIR') means the add-on only tries to attach when Scalability Pro is actually active.

Notes

A few constants are internal and not intended for you to redefine, though they are handy to read. SPRO_VERSION holds the plugin version (read from the plugin header), SPRO_PLUGIN_NAME is the display name, and SPROPLUGIN_DIR is the plugin’s base directory, which is the value an add-on checks before registering.

SPRO_DB_VERSION (currently 6.13) tracks the schema version of Scalability Pro’s own tables and drives upgrade routines, so treat it as read-only. SPRO_ROW_CACHE_KEY is an internal cache-key prefix for the cached admin list tables and should not be redefined. If you are relying on the Remove Image Sizes Globally feature, note that it is driven by its own settings rather than a constant, so configure it from the settings screen rather than in wp-config.php.

Further reading

Related products

Scalability ProSpeed up your whole site – big catalogues, big databases, no re-architecture