概要
wp_debug_backtrace_summary関数は、デバッグ用の呼び出し情報を取得するために使用され、特にプラグイン開発やテーマの開発時に役立ちます。この関数は、スタックトレースのまとめを提供し、コードの実行フローを理解しやすくします。
よく用いられるシナリオは以下の通りです。
1. エラー発生時の呼び出し元を追跡
2. プラグインのパフォーマンス分析
3. コードのリファクタリング
4. 開発中の機能のデバッグ
5. テーマのカスタマイズによるエラー診断
6. 複数のプラグインの競合チェック
7. APIコールの履歴確認
8. 一貫したデバッグ出力を提供
構文
wp_debug_backtrace_summary( $stack = null, $ignore_noe = false );
パラメータ
$stack(array|null) – デフォルトはnull。バックトレースを取得する際に、特定のスタック情報を渡せます。$ignore_noe(bool) – デフォルトはfalse。falseの場合、無視しないエラーも含まれます。
戻り値
string– デバッグ用の呼び出し情報が含まれた文字列を返します。
関連する関数
使用可能なバージョン
この関数は、WordPress 4.0以降で利用可能です。
コアファイルのパス
wp-includes/functions.php
サンプルコード
サンプルコード1: 基本的な使用法
function my_function() {
echo wp_debug_backtrace_summary();
}
my_function();
このコードは、my_functionが呼び出された位置に関するデバッグ情報を表示します。
サンプルコード2: 引数を指定して呼び出す
function another_function( $arg ) {
$trace_summary = wp_debug_backtrace_summary( null, true );
error_log( $trace_summary );
}
another_function('test');
このコードは、引数を受け取りつつ、エラーログに呼び出し情報を記録します。
サンプルコード3: スタック情報を利用する
function example_function() {
$trace = debug_backtrace();
echo wp_debug_backtrace_summary( $trace );
}
example_function();
このサンプルでは、debug_backtraceを使ってスタック情報を取得し、それをwp_debug_backtrace_summaryで表示します。
サンプルコード4: エラーの無視設定
function error_example() {
$trace_summary = wp_debug_backtrace_summary( null, true );
echo $trace_summary;
}
error_example();
このコードは、エラーを無視せずにデバッグ情報を出力し、分析に役立てます。
サンプルコード5: プラグイン開発時の使用例
add_action('init', function() {
if ( is_admin() ) {
echo wp_debug_backtrace_summary();
}
});
ここのコードは、管理画面でinitアクションが発火するたびにデバッグ情報を表示します。
この関数のアクションでの使用可能性
| アクション | 使用可能性 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | 〇 |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head |
非推奨または削除されたバージョン
この関数は現在のところ非推奨または削除されていません。