wp_debug_backtrace_summary( string $ignore_class = null, int $skip_frames, bool $pretty = true )
Return a comma-separated string 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 or not you want a comma separated string or 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 ) {
$trace = debug_backtrace( false );
$caller = array();
$check_class = ! is_null( $ignore_class );
$skip_frames++; // skip this function
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' ) ) ) {
$caller[] = "{$call['function']}('{$call['args'][0]}')";
} elseif ( in_array( $call['function'], array( 'include', 'include_once', 'require', 'require_once' ) ) ) {
$caller[] = $call['function'] . "('" . str_replace( array( WP_CONTENT_DIR, ABSPATH ) , '', $call['args'][0] ) . "')";
} else {
$caller[] = $call['function'];
}
}
}
if ( $pretty )
return join( ', ', array_reverse( $caller ) );
else
return $caller;
}
Changelog
| Version | Description |
|---|---|
| WP-3.4.0 | Introduced. |