wp_debug_backtrace_summary() WordPress Function
The wp_debug_backtrace_summary() function is a utility function that simplifies the output of a backtrace. When called, it will return a summary of the backtrace as a string. This can be useful for debugging purposes, as it can help to quickly identify the most relevant information in a backtrace.
wp_debug_backtrace_summary( string $ignore_class = null, int $skip_frames, bool $pretty = true ) #
Returns a comma-separated string or array of functions that have been called to get to the current point in code.
Description
See also
Parameters
- $ignore_class
(string)(Optional)A class to ignore all function calls within
- useful when you want to just give info about the callee.
Default value: null
- $skip_frames
(int)(Optional)A number of stack frames to skip
- useful for unwinding back to the source of the issue. Default 0.
- $pretty
(bool)(Optional) Whether you want a comma separated string instead of the raw array returned.
Default value: true
Return
(string|array) Either a string containing a reversed comma separated trace or an array of individual calls.
Source
File: wp-includes/functions.php
function wp_debug_backtrace_summary( $ignore_class = null, $skip_frames = 0, $pretty = true ) { static $truncate_paths; $trace = debug_backtrace( false ); $caller = array(); $check_class = ! is_null( $ignore_class ); $skip_frames++; // Skip this function. if ( ! isset( $truncate_paths ) ) { $truncate_paths = array( wp_normalize_path( WP_CONTENT_DIR ), wp_normalize_path( ABSPATH ), ); } foreach ( $trace as $call ) { if ( $skip_frames > 0 ) { $skip_frames--; } elseif ( isset( $call['class'] ) ) { if ( $check_class && $ignore_class == $call['class'] ) { continue; // Filter out calls. } $caller[] = "{$call['class']}{$call['type']}{$call['function']}"; } else { if ( in_array( $call['function'], array( 'do_action', 'apply_filters', 'do_action_ref_array', 'apply_filters_ref_array' ), true ) ) { $caller[] = "{$call['function']}('{$call['args'][0]}')"; } elseif ( in_array( $call['function'], array( 'include', 'include_once', 'require', 'require_once' ), true ) ) { $filename = isset( $call['args'][0] ) ? $call['args'][0] : ''; $caller[] = $call['function'] . "('" . str_replace( $truncate_paths, '', wp_normalize_path( $filename ) ) . "')"; } else { $caller[] = $call['function']; } } } if ( $pretty ) { return implode( ', ', array_reverse( $caller ) ); } else { return $caller; } }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
3.4.0 | Introduced. |