Skip to main content

Debug

The Debug section in WP Toolkit lets you manage WordPress debugging constants (WP_DEBUG, WP_DEBUG_LOG, and WP_DEBUG_DISPLAY) from the ServerAvatar panel. Changes are written to your application configuration automatically, so you do not need to edit wp-config.php manually.

WordPress debugging helps identify PHP errors, warnings, and notices that occur during site execution. These issues often appear after plugin or theme updates, custom code changes, or server configuration updates. With debugging enabled, administrators can collect the information required to diagnose and resolve problems efficiently.

Accessing Debug Settings

Step 1: Log in to your ServerAvatar account.

Step 2: Open the Server DashboardApplications → select your WordPress application.

Step 3: In the application panel sidebar, open WP ToolkitDebug.

WP Toolkit Debug page

The table below outlines typical settings by environment. Adjust values according to your security and troubleshooting requirements.

EnvironmentDebug ModeDebug LogDisplay Errors
Live production (active troubleshooting)OnOnOff
Staging or local developmentOnOnOn (non-public sites only)
Standard operationOffOffOff
caution

On public production sites, do not leave Debug Mode and Display Errors enabled after troubleshooting is complete. Exposed error output may reveal file paths, plugin details, or other sensitive information.

info

Enable Debug Mode before Debug Log. Display Errors should remain disabled on production sites; use Debug Log to review errors in wp-content/debug.log via the File Manager.

Debug Mode

Debug Mode (WP_DEBUG) is the primary control for WordPress debugging. When enabled, WordPress records runtime issues including PHP errors, warnings, and notices. Disable this setting when troubleshooting is complete to restore standard production behavior.

In the Debug Mode section, set the toggle to the enabled or disabled position.

Debug Mode section

Debug Log

Debug Log (WP_DEBUG_LOG) writes debug output to a log file on the server, typically located at wp-content/debug.log. This allows administrators to review errors without displaying them on the website, which is the preferred approach for production environments.

This setting should be used together with Debug Mode enabled.

In the Debug Log section, set the toggle to the enabled or disabled position.

Debug Log section

Display Errors

Display Errors (WP_DEBUG_DISPLAY) determines whether debug messages are rendered on the front end and in the WordPress admin dashboard. When enabled, technical error details may be visible to site visitors.

This setting is appropriate for local or restricted staging environments. For live production sites, keep Display Errors disabled and rely on Debug Log for error review.

In the Display Errors section, set the toggle to the enabled or disabled position.

Display Errors section

Post-Troubleshooting

After resolving the underlying issue, disable Debug Mode, Debug Log, and Display Errors to return the application to normal operation.

If logging was enabled, you may delete or archive wp-content/debug.log from the application File Manager when it is no longer required.