おちです。
先日コメントフォームの改造をしました。
Codex見て、パラメータセットして、動いたの確認して「めでたしめでたし」の筈だったんですけど デバッグモードでチェックしたら PHP の「Notice: Undefined variable:」エラーが出ましてん。
改めてコメントフォーム表示部である $fields の中身を確認したら、英語版 Codex には詳細記述があるけど日本語 Codex には初期化用コードが載ってないことに気づきました。
検索してみたら、そこに言及してる日本語情報があまりなかったのでメモしておきます。
WordPressのコメントフォームを徹底的に改造する
一般的に single.php のコメントフォーム呼び出し部には、以下のコードが記載されてます。
【comments.php】
<?php comment_form(); ?>
この一行でコメントフォームが全て展開されるとか超便利ですね。…って、今から全部書き換えるんですけど。
コメントフォームのデフォルト格納データ一式
当初、日本語版Codexを参考にして、コメントフォームに必要なパラメータを一通り抜き出しました。
【comments.php】
<?php $args = array(
'fields' = array(
// 名前
'author' => '<p class="comment-form-author">' . '<label for="author">' . __( 'Name' ) . '</label> ' . ( $req ? '<span class="required">*</span>' : '' ) .
'<input id="author" name="author" type="text" value="' . esc_attr( $commenter['comment_author'] ) . '" size="30"' . $aria_req . ' /></p>',
// メール
'email' => '<p class="comment-form-email"><label for="email">' . __( 'Email' ) . '</label> ' . ( $req ? '<span class="required">*</span>' : '' ) .
'<input id="email" name="email" type="text" value="' . esc_attr( $commenter['comment_author_email'] ) . '" size="30"' . $aria_req . ' /></p>',
// WEBサイト
'url' => '<p class="comment-form-url"><label for="url">' . __( 'Website' ) . '</label>' .
'<input id="url" name="url" type="text" value="' . esc_attr( $commenter['comment_author_url'] ) . '" size="30" /></p>',
),
// コメント枠
'comment_field' => '<p class="comment-form-comment"><label for="comment">' . _x( 'Comment', 'noun' ) . '</label><textarea id="comment" name="comment" cols="45" rows="8" aria-required="true"></textarea></p>',
// ログインを促すメッセージ
'must_log_in' => '<p class="must-log-in">' . sprintf( __( 'You must be <a href="%s">logged in</a> to post a comment.' ), wp_login_url( apply_filters( 'the_permalink', get_permalink( $post_id ) ) ) ) . '</p>',
// 登録ユーザがログインしたときの表示
'logged_in_as' => '<p class="logged-in-as">' . sprintf( __( 'Logged in as <a href="%1$s">%2$s</a>. <a href="%3$s" title="Log out of this account">Log out?</a>' ), admin_url( 'profile.php' ), $user_identity, wp_logout_url( apply_filters( 'the_permalink', get_permalink( $post_id ) ) ) ) . '</p>',
// コメント頭の注意書き「メールアドレスは公開されません」
'comment_notes_before' => '<p class="comment-notes">' . __( 'Your email address will not be published.' ) . ( $req ? $required_text : '' ) . '</p>',
// コメント後半の注意書き「以下のタグが使えます」
'comment_notes_after' => '<p class="form-allowed-tags">' . sprintf( __( 'You may use these <abbr title="HyperText Markup Language">HTML</abbr> tags and attributes: %s' ), ' <code>' . allowed_tags() . '</code>' ) . '</p>',
// コメントフォームの表記
'id_form' => 'commentform',
// 送信ボタンの表記
'id_submit' => 'submit',
// 「コメントをどうぞ」
'title_reply' => __( 'Leave a Reply' ),
// 返信先の表示
'title_reply_to' => __( 'Leave a Reply to %s' ),
// キャンセルボタン（いじってもコア側で非表示にされます）
'cancel_reply_link' => __( 'Cancel reply' ),
// 送信ボタンのラベル
'label_submit' => __( 'Post Comment' ),
);
comment_form($args);
?>
…ということで必要な項目を上書きすれば好きなようにカスタマイズ出来る…んですけど、実はこのままだとエラーになるという微妙な状態です。（震え）
記入欄の変数 $aria_req を初期化するには
ただ、前章のままでも動きます。だから気づくのに遅れたんですけど、デバッグモードでチェックすると地味に怒られるんですよね。
具体的には ‘fields’ の変数が「Notice: Undefined variable:」となるので、事前に初期化しておきます。
【comments.php】
<?php
$commenter = wp_get_current_commenter();
$req = get_option( 'require_name_email' );
$aria_req = ( $req ? " aria-required='true'" : '' );
$args = array(
// 前章で書き出した $args の中身を好きなだけ
);
comment_form($args);
?>
デバッグモードでエラーチェックする方法
ぱっと見で問題なく動作しているように見えるテーマファイルも、デバッグモードで動かすと想像以上にエラーが出てくるものです。致命的じゃないから動いちゃってるけど、あんまりほったらかしも良くない感じのアレ。
チェックするにはルートにあるコアファイル wp-config.php の設定を変えます。function.php 以上に重要なファイルなので必ずバックアップを取ってから実行して下さい。
【wp-config.php】
define('WP_DEBUG', true);
80行くらいのところにある WP_DEBUG に true をセットしたら目的のテーマをブラウザで表示させてみて下さい。
ちなみにこの作業、思いっきりエラーメッセージが出て非常にカッコ悪いので人が少ない時間帯に行うのをオススメします。
…というより、エラーメッセージは見る人が見ると内部処理がダダ漏れなので、実行環境で試すときはログファイルに保存してこっそり見るのが吉でしょう。
【wp-config.php】
define('WP_DEBUG', true);
if (WP_DEBUG) { // デバッグモードの時
define('WP_DEBUG_DISPLAY', false); // ディスプレイ非表示にする
define('WP_DEBUG_LOG', true); //ログに書き出す
}
参考：WP DEBUG – WordPress Codex（英語版）
このとき、ログファイルは以下のディレクトリに保存されます。（見あたらなかったら書き込み許可した空ファイルを該当箇所に突っ込んでください。）
root/wp-content/debug.log
…というわけで、コメント欄を心ゆくまで改造できるようになりました。(^^
作業終了時 ‘WP_DEBUG’ を false に戻すのと、ログファイル消すの忘れないようにして下さいね～。
コメントをどうぞ(´ω｀*)