_doing_it_wrong()


WordPressの関数_doing_it_wrong()は、推奨されない使い方や非推奨の機能に関する警告をログに記録するために使用されます。

構文

_doing_it_wrong( string $function, string $message, string $version );

引数の説明:

  • $function (string) — 問題のある関数名。
  • $message (string) — 警告メッセージ。
  • $version (string) — 問題が導入されたWordPressのバージョン。

例 1: 非推奨の関数使用の警告

以下のコードは、特定の関数の使用が推奨されないことを示します。

<?php
_doing_it_wrong( 'my_deprecated_function', 'この関数は非推奨です。代わりに new_function() を使用してください。', '6.0.0' );
?>

例 2: プラグイン内で非推奨の機能を警告

特定のプラグインで非推奨の機能を検出した場合に使用します。

<?php
if ( function_exists( 'old_plugin_function' ) ) {
    _doing_it_wrong( 'old_plugin_function', 'このプラグイン関数は非推奨です。', '5.9.0' );
}
?>

例 3: 関数の代替案を示す警告

警告メッセージで新しい関数を提案します。

<?php
_doing_it_wrong( 'old_function', '新しい関数 new_function() を使用してください。', '5.8.0' );
?>

例 4: テーマ内の非推奨テンプレートタグ

テーマで非推奨のテンプレートタグを検出する際に使用します。

<?php
if ( function_exists( 'old_template_tag' ) ) {
    _doing_it_wrong( 'old_template_tag', 'このテンプレートタグは非推奨です。', '6.1.0' );
}
?>

例 5: カスタム関数のデバッグ

カスタム関数の使用が誤っている場合に警告を表示します。

<?php
function my_custom_function() {
    if ( ! is_admin() ) {
        _doing_it_wrong( 'my_custom_function', 'この関数は管理画面でのみ使用してください。', '6.2.0' );
    }
}
?>

注意点

  • この関数は通常、テーマやプラグインのデバッグモードでのみ使用されます。
  • 本番環境では非推奨機能の使用を避けるべきです。

関連機能：