WordPressのテーマをカスタマイズする場合に役立つコメントアウトの書き方

WordPressのテーマをカスタマイズしようと取り組む人も多いかと思います。
しかし多くの人は知識のない状態で取り組んでいるのではないでしょうか。

例えコメントアウトの仕方1つであっても多少の知識がないと思わぬ不具合を生じさせてしまうかもしれません。
せめて安全にコメントアウトできるよう、やり方について書いてみました。

多分一番問題が生じるであろうPHP関係について主に説明しています。

HTMLとCSSとPHPの違い

WordPressのテーマはHTMLとCSSとPHPの知識が要求されます。
困ったことに、コメントアウトの仕方がそれぞれ違うのです。

HTMLの場合

「<!–」で始まり「–>」で囲まれた範囲をコメントとして扱います。
複数行に渡っても問題ありません。

CSSの場合

「/*」で始まり「*/」で囲まれた範囲をコメントとして扱います。
ただし、「*/」の直前に全角文字があると上手く動作しません。
半角スペースを空けるよう心がけておくと見易さと確実さを両立できます。

指定された範囲が複数行に渡っても問題ありません。

PHPの場合

PHPでコメントアウトする方法は複数あります。

「//」を使う場合

「//」から後を行末までコメントとして扱います。
1行のみ有効です。

「/*」と「*/」を使う場合

「/*」で始まり「*/」で囲まれた範囲をコメントとして扱います。
複数行をまとめてコメントアウトする場合に便利です。
1行の中の、ある部分だけコメントアウトする場合にも利用できます。

「#」を使う場合

WordPressのテーマをカスタマイズしていて見かけたことはありませんが、「#」を使うやり方もあります。
使い方は「//」の場合と同じです。
特に使わなくても問題ないと思います。

PHPで安全にコメントアウトするために

WordPressのテーマはPHPを利用し、他のファイルを読み込んでいます。
1つのファイルでは問題なく動作していても、他のファイルを読み込んだら思わぬ動作になってしまうかもしれません。
他のファイルがどうなっているのか考慮しなくても済むよう、安全にコメントアウトしましょう。

安全にコメントアウトする方法

恐らく一番問題になるケースがPHPで別ファイルを読み込むところです。

別のファイルを読み込む場合、次のようになっていると思います。
この場合はコメントテンプレートですが、他の場合も同様です。

<?php comments_template(); ?>

これをコメントアウトする場合、PHPとしてコメントアウトする必要があります。
次のようにコメントアウトしましょう。

<?php //comments_template(); ?>

「<?php」と「?>」で囲まれた内部をコメントアウトしてみました。
「<?php」と「?>」の外側でコメントアウトすると、読み込んだファイルの中身の関係で思ったようにコメントアウトできない場合があるので注意しましょう。

コメントアウトに失敗した場合の一例

コメントアウトに失敗している場合、「–>」という文字が意図せず表示されているかもしれません。
このような場合は「<?php」と「?>」の外側でコメントアウトしていないかチェックしてください。
もし「<?php」と「?>」で囲まれた外側でコメントアウトしていた場合は内部でコメントアウトするようにしましょう。

発想を変えて根本的に解決する

実はこの方法が一番簡単なのではないかと思うのですが、わざわざコメントアウトで元の内容を残すのではなく、別のファイルにバックアップを取り、カスタマイズするファイルの不要な部分を容赦なく削除する方法です。

これなら思ったようにコメントアウトできていないというミスがなくなります。
しかもコメントアウトだらけの見難いソースになることも防げます。

「○○を削除」みたなコメントを残しておけば、後から見ても何を削除したのか分かりやすいです。

コメントアウトの書き方という趣旨とは違ってしまいますが、複数行をコメントアウトするくらいなら削除してしまったほうが見た目も動作の確実性も良くなると思います。

終わりに

HTMLとCSSは簡単に説明してみました。
そして一番問題になって解決方法で悩みそうなPHP関係を主に説明してみました。

コメントアウトする位置で思わぬ不具合が生じた経験のある人も多いのではないでしょうか。
私も大いに悩みました。
この記事が同じような悩みを抱えている人の助けになれば幸いです。

スポンサーリンク
レクタングル(大)
レクタングル(大)

フォローする

スポンサーリンク
レクタングル(大)