---
title: "How To Use WP DEBUG To Isolate Issues"
source: "https://docs.nexcess.com/software/general/use-wp-debug/"
description: "When troubleshooting WordPress sites, the WP DEBUG feature is a powerful tool for identifying and isolating issues. This guide will walk you through enabling WP…"
vertical: "Software"
area: "General"
date: "2025-01-24"
last_modified: "2026-10-26"
---

# How To Use WP DEBUG To Isolate Issues

When troubleshooting WordPress sites, the WP DEBUG feature is a powerful tool for identifying and isolating issues. This guide will walk you through enabling WP DEBUG, understanding its outputs, and using it effectively to diagnose problems on your WordPress site.

## Why Use WP DEBUG?

WP DEBUG is a built-in WordPress feature that provides detailed error reporting. It helps you:

- Identify PHP errors and warnings.
- Pinpoint deprecated functions or notices.
- Gain insights into plugin or theme conflicts.
- Debug custom code in a controlled environment.

By activating WP DEBUG, you’re able to see precisely what is causing issues and address them with confidence.

## Prerequisites

Before proceeding, ensure you have:

- Access to your site’s file system via FTP, SFTP, or your hosting control panel.
- A basic understanding of editing files such as `wp-config.php`. See [Editing and handling wp-config.php](https://docs.nexcess.com/software/kadence/solid/general-wp/edit-wp-config-php/) to gain more confidence in editing this file.
- Administrator privileges for your WordPress installation.

> **Note:** Make a backup of your site before enabling WP DEBUG to prevent accidental data loss or site disruptions.

## Enabling WP DEBUG

Here is how to enable WP Debug log:

1. **Access the File System:**
    - Use an FTP client or hosting file manager to navigate to your WordPress root directory. This is where the `wp-config.php` file is located.
2. **Edit the `wp-config.php` File:**
    - Open the `wp-config.php` file for editing. This file contains key settings for your WordPress installation. See our article [Editing and handling wp-config.php](https://docs.nexcess.com/software/kadence/solid/general-wp/edit-wp-config-php/) to become confident in your ability to modify the file.
3. **Enable WP DEBUG with Recommended Settings:**
    - Add or update the following lines in your `wp-config.php` file:
    - `define( 'WP_DEBUG', true ); `
    - `define( 'WP_DEBUG_LOG', true ); `
    - `@ini_set('display_errors', 0); `
    - `define('WP_DEBUG_DISPLAY', false);`
4. **Adjust PHP Error Reporting (Optional**): 
    - To fine-tune which errors are reported, you can modify the `error_reporting` level in your `wp-config.php` file:
    - `@ini_set( 'error_reporting', E_ALL & ~E_DEPRECATED & ~E_USER_DEPRECATED );`
    - This will report all errors except PHP deprecation warnings and notices. This is particularly useful when running PHP 8.2 or higher, where deprecated notices are more prevalent.
5. **Save and Upload the File:**
    - Save your changes and upload the file back to your server if using an FTP client.

## Understanding WP DEBUG Outputs

With WP DEBUG enabled, errors and warnings will be logged to the `debug.log` file located in the `wp-content` directory. The log provides:

- **On-Screen Display:** With `WP_DEBUG_DISPLAY` set to `true`, errors will be displayed directly on your site pages. This is useful for immediate feedback during development but **should be turned off in production environments**.
- **Log File:** With `WP_DEBUG_LOG` set to `true`, errors will be logged to a `debug.log` file located in the `wp-content` directory. This is helpful for reviewing errors that occur during background processes or AJAX requests.
- **Error Type:** Examples include “Fatal Error,” “Warning,” or “Notice.” 
    - `E_DEPRECATED`: Notices about deprecated functions or arguments within WordPress that are being used on your site.
    - `E_USER_DEPRECATED`: User-generated deprecation notices triggered by plugins or themes.
- **File and Line Number:** Where the issue occurred in the code.
- **Detailed Message:** Explaining the issue, such as a missing function or an undefined variable.

### PHP Deprecation Notices vs. Errors

It’s important to distinguish PHP deprecation notices from actual errors.

A deprecation notice (typically `E_DEPRECATED` or `E_USER_DEPRECATED`) indicates that a plugin or theme is using a PHP feature or syntax that will be removed in a future PHP version. It serves as an early warning, not a critical failure. In contrast, PHP errors—such as fatal or parse errors—break site functionality and require immediate fixes.

You can use `WP_DEBUG` to monitor both types of messages. If deprecation warnings appear in your logs, they generally will not disrupt your site’s functionality. You can safely suppress them in production environments (e.g., via `@ini_set( 'error_reporting', E_ALL & ~E_DEPRECATED & ~E_USER_DEPRECATED );`) while leaving them active on staging or local development sites. Treat deprecation notices as planning cues for future updates rather than urgent site-down emergencies.

## Using WP DEBUG to Diagnose Issues

**1. Reproduce the Issue**

- Navigate to the part of your site where the issue occurs.
- Perform actions that trigger the error or conflict.

**2. Review Error Messages**

- Download the `debug.log` file from the `wp-content` directory and open it in a text editor.

3\. **Analyze the Output:**

- Look for recurring errors or warnings.
- Identify whether the issue originates from a plugin, theme, or custom code.

4\. **Isolate the Problem:**

- Deactivate all plugins and switch to a default theme (e.g., Twenty Twenty-Three).
- Reactivate plugins one by one to pinpoint conflicts.
- Use the error details to narrow down specific files or code snippets causing the issue.

## Disabling WP DEBUG

Once you’ve resolved the issue, disable WP DEBUG to ensure your site runs securely:

1. **Edit `wp-config.php` Again:**
    - Change the line back to: `define( 'WP_DEBUG', false );`
2. **Remove Debug Logs:**
    - Delete the `debug.log` file from the `wp-content` directory.

> **Important:** Leaving WP DEBUG enabled on a live site can expose sensitive information to visitors.

## Tips for Effective Debugging

- **Work in a Staging Environment:** Always debug on a staging site to avoid impacting live users.
- **Stay Updated:** Ensure your WordPress core, themes, and plugins are up to date to reduce conflicts.
- **Use Error Messages to Research:** Search for error messages online to find solutions or similar cases.
- **Reach Out for Help:** If you’re stuck, consult the WordPress support forums, plugin or theme author, or your hosting provider.

By using WP DEBUG effectively, you can identify and resolve issues swiftly, minimizing downtime and maintaining a seamless experience for your site’s users.
