UM Debug tools releases

Simple tool for logging and testing.

Key Features:

• Display WordPress log (the debug.log file) to the screen. Color errors and warnings. Feature: filter log by keyword.
• Log mails to _ummail.log file and display mails log to the screen. Feature: show a list of all email recipients.
• Log information about specific hooks to _umhook.log file and display hooks log to the screen.
• A profiling tool that shows the execution time of specific hooks.
• A testing tool to execute custom PHP code.
• Special features for debugging: display variable value, show backtrace, code profiling.

Installation

How to install from GitHub

Open git bash, navigate to the plugins folder and execute this command:

git clone --branch=main git@github.com:umdevelopera/um-debug.git um-debug

Once the plugin is cloned, enter your site admin dashboard and go to wp-admin > Plugins > Installed Plugins. Find the UM Debug tools plugin and click the Activate link.

How to install from ZIP archive

You can install this plugin from the ZIP file as any other plugin. Follow this instruction.

How to use

How to log PHP errors

WordPress can save information about PHP issues to the debug.log file. See Debugging in WordPress. To enable debug logging you should use FTP to open the wp-config.php file, find the line define( 'WP_DEBUG', false ); and replace this line with a code below:

define( 'WP_DEBUG', true );
define( 'WP_DEBUG_LOG', true );
define( 'WP_DEBUG_DISPLAY', false );

Go to wp-admin > Tools > UM Debug > Debug Log to view the debug.log file records.

How to log emails

Go to wp-admin > Tools > UM Debug > Mail Log.

Turn ON the "Enable" setting. Turn YES the "Log backtrace" setting if you wish to log detailed info. Filter a mail you wish to investigate using the Conditions settings. You can filter logging by a specific hook or the email subject. All mails will be logged if Conditions are empty. Save settings.

Send email from the website. You'll see the mail log records below the settings.

How to log hooks

Go to wp-admin > Tools > UM Debug > Hook Log.

Turn ON the "Enable" setting. Turn YES the "Log backtrace" setting if you wish to log detailed info. List hooks you wish to investigate in the Hooks setting. You can list multiple hooks separated by commas. Save settings.

Do a test. You'll see the hook log records below the settings.

This tool is helpful for investigating strange redirects and user deletions.

• Add the wp_redirect hook to the Hooks setting to collect redirect details and backtrace.
• Add the delete_user hook to the Hooks setting to collect details related to user deletion.

How to profile website

Go to wp-admin > Tools > UM Debug > Profiling.

List hooks you wish to investigate in the Hooks setting. You can list multiple hooks separated by commas. Save settings.

Go to the page you wish to investigate. At the bottom you will see a collapsed panel. Hover over the panel to expand it.

Every hook call is shown in a format Time : Delta - Key, where

• Time is a time from the beginning;
• Delta is a time difference from the previous hook;
• Key is a hook name.

Functions for testing and profiling

Add umd( $var, $key ) to the code where you want to see the $var variable value. The $key parameter is a label for the variable.

Add umdb( $key ) to the code where you want to see a backtrace. The $key parameter is a label for the backtrace.

How to execute custom code

Go to wp-admin > Tools > UM Debug > Test code.

Enter PHP code to the "Snippet" area and click the "Eval" button.

This tool is helpful for calling specific hooks manually.

Support

Open new issue if you are facing a problem or have a suggestion.