Skip to main content

Debugging issues with the Freemius WordPress SDK

Freemius has inbuilt options for debugging and logging issues so as to make the integration process easier for developers. Here is how to enable and use these features:

Access the Freemius Debug Page

To get information about the active SDK, Freemius-powered products on the site, users, and more, you need to access the Freemius Debug page.

Opening up the Freemius debug page, enables you to discover any issues going on with the SDK and/or your integration.

To activate it, set WP_FS__DEV_MODE to true in the the wp-config.php as below:

define( 'WP_FS__DEV_MODE', true );

This adds a new Freemius Debug admin menu item located directly underneath the Settings menu in the WP Admin.

If you don't have debugging enabled, then you can reach this page by manually navigating to {domain}/wp-admin/admin.php?page=freemius. It will open up the page which displays as:

tip

Sometimes, issues can be solved just by clearing the Freemius API cache, which you can do via the debug page.

This page activation will automatically activate the logger that outputs all logs to your browser's debugging console.

Output Logs to Screen

You can output all logs to the screen by adding &fs_dbg_echo=true to the query string.

Security Tip

Adding fs_dbg_echo=true to the query string will only work when Freemius is set to development mode. Therefore, websites using your product are not at risk of exposing the logs unless an administrator sets WP_FS__DEV_MODE to true or manually toggles on the debugging switch in the Freemius Debug page.

Debug Bar Integration

Additionally, if you are using Debug Bar, Freemius SDK logging is fully integrated with it to make debugging even easier with its UI.