ものすごく初歩的な内容ですが、PHPファイルのコメントアウトの方法についての備忘録です。
やりたいこと:既存のPHPファイルの一部をコメントアウトする
本ブログで使用している無料WordPressテーマ「STINGER」は、Googleアドセンス用の広告が、記事下に2つ連続で表示される仕様になっています。
それを、1つのみの表示にするよう改造したく、ソースをコメントアウトすることにしました。
(Googleアドセンス、本当は使用したいのですが、審査が厳しく通過できない・・・orz)
つまづいた点:まるごと囲むだけではNG
テキストエディタで範囲を選択して、command + / でコメントアウト完了・・・と思いきや、コメント箇所の色が変わっていない部分がありました。
原因:HTMLだけでなくPHP内もコメントアウトしなければならない。
やったこと:HTMLとPHPのコメントアウト
single.phpの広告枠の一部をコメントアウトしたい
今回修正したい箇所は、single.phpの下記の黄色くマークした行です。
121 122 123 124 125 126 127 128 129 130 131 132 133 134 |
<!-- 広告枠 --> <div class="adbox"> <?php get_template_part( 'ad' ); //アドセンス読み込み ?> <?php if ( st_is_mobile() ) { //スマホの場合 ?> <div class="adsbygoogle" style="padding-top:10px;"> <?php get_template_part( 'st-smartad' ); //スマホ用広告読み込み ?> </div> <?php } else { //PCの場合 ?> <div style="padding-top:10px;"> <?php get_template_part( 'ad' ); //アドセンス読み込み ?> </div> <?php } ?> </div> <!-- /広告枠 --> |
解説
123行目と130行目の両方でget_template_part( ‘ad’ )が呼ばれています。
これにより、広告が2回連続で表示されていたので、後半をコメントアウトしてみます。
HTMLまるごとコメントアウトしてみた
真っ先にやってみたのがこれでした。
121 122 123 124 125 126 127 128 129 130 131 132 133 134 |
<!-- 広告枠 --> <div class="adbox"> <?php get_template_part( 'ad' ); //アドセンス読み込み ?> <!-- <?php if ( st_is_mobile() ) { //スマホの場合 ?> <div class="adsbygoogle" style="padding-top:10px;"> <?php get_template_part( 'st-smartad' ); //スマホ用広告読み込み ?> </div> <?php } else { //PCの場合 ?> <div style="padding-top:10px;"> <?php get_template_part( 'ad' ); //アドセンス読み込み ?> </div> <?php } ?> --> </div> <!-- /広告枠 --> |
解説
該当箇所をまるごと選択して、<!– –>で囲んでコメントアウトしました。
ところが、これではHTMLソースのコメントアウトだけになってしまい、PHPスクリプト内のソースは活きたままでした。
PHP内部もコメントアウトしてみた
さらに、PHP内部をコメントアウトしてみました。
121 122 123 124 125 126 127 128 129 130 131 132 133 134 |
<!-- 広告枠 --> <div class="adbox"> <?php get_template_part( 'ad' ); //アドセンス読み込み ?> <!-- <?php //if ( st_is_mobile() ) { //スマホの場合 ?> <div class="adsbygoogle" style="padding-top:10px;"> <?php //get_template_part( 'st-smartad' ); //スマホ用広告読み込み ?> </div> <?php //} else { //PCの場合 ?> <div style="padding-top:10px;"> <?php //get_template_part( 'ad' ); //アドセンス読み込み ?> </div> <?php } ?> --> </div> <!-- /広告枠 --> |
解説
PHP内部を、//で一行ずつコメントアウトしました。
今度こそ、コメントアウトに成功しました。
PHP内部をまとめてコメントアウトしてみた
先ほどの方法では手間がかかってしまうということで、こちらの方法も試してみました。
121 122 123 124 125 126 127 128 129 130 131 132 133 134 |
<!-- 広告枠 --> <div class="adbox"> <?php get_template_part( 'ad' ); //アドセンス読み込み ?> <?php /* if ( st_is_mobile() ) { //スマホの場合 ?> <div class="adsbygoogle" style="padding-top:10px;"> <?php get_template_part( 'st-smartad' ); //スマホ用広告読み込み ?> </div> <?php } else { //PCの場合 ?> <div style="padding-top:10px;"> <?php get_template_part( 'ad' ); //アドセンス読み込み ?> </div> <?php } */ ?> </div> <!-- /広告枠 --> |
解説
PHP内部を、/* */で囲ってコメントアウトしました。
この方法が一番楽そうです。
まとめ
HTMLとPHPでコメントの形式が異なることを注意しなければなりません。
HTMLのコメントアウト
- <!– 単一行のコメント
複数行のコメント –>
PHPのコメントアウト
- // 単一行のコメント(C++型)
- # 単一行のコメント(シェル型)
- /* 複数行のコメント
複数行のコメント */
以上です。