PHPの編集 消去せずにコメントアウトする方法

テーマのカスタマイズ

ワードプレスのテーマのカスタマイズでPHPを編集する時がありますよね。
賢威のカスタマイズを解説しているブログを見ても

single.php の○○行目の <?php if(get_the~ ?> の 部分を削除して~

といったように、phpのコードを部分削除したり書き換える、といった記事をよく見かけます。

ブログのカスタマイズでは当たり前のように行っている事なのですが、テーマのバージョンアップをする時などは変更した箇所を見落とす場合もありますよね。

あれ?どこ変更したっけ?」なんてことならないように、phpを編集する時は、オリジナルのコードを削除や変更するのではなく、削除/変更の箇所をコメントアウトする方法がおすすめです。もちろんバックアップは必須ですよ。

コメントアウトとは?

コメントとはプログラムコードの部分に記述する注意書きのようなものです。ブラウザはコメントアウトされた部分を無視しますので、本来の注釈や覚え書き以外にもいろいろな使われ方をしています。

例えばphpのコードを部分削除する場合、削除する部分をコメントアウトしておけば、ブラウザからは削除したことと同様になります。
コメントアウトする利点は、元のコードを削除していないので、どこを変更/削除したかが判り、元にもどすのも簡単に出来ることです。

phpでコメントアウトする3つの方法

phpではコメントアウトする記述はの以下の3つの方法があります。

『/*』でコメントアウト

まず、よく使われるるのが /* */ でコメントアウトする方法です
「/(スラッシュ)」と「*(アスタリスク)」で囲みます。

/* コメント 
コメント
コメント
*/

/*と*/の間で、複数行をコメントアウトする場合に使われます。

『//』(スラッシュ2つ)でコメントアウト

次が // (スラッシュ)でコメントアウト

//(スラッシュ2つ)で始まる行がコメントアウトとなります。

PHPでは //(スラッシュ2つ)が先頭にある行の終わりまでのコードを無視します。改行または、PHP終了タグ「?>」が出るまでコメント化が続きます。

『#』 (シャープ)でコメントアウト

//と同様に行単位でコメントアウトするもので#(シャープ)でコメント化します。

複数行をコメントアウトする場合は「/(スラッシュ)」と「*(アスタリスク)」で囲み、1行だけコメントアウトする場合はスラッシュ2つやシャープ記号が使えます。

まとめ

上記3つのいずれかでコードをコメントアウトすれば、オリジナルコードを保持したまま変更、削除が出来るので確実に間違いが減ると思います。

  1. PHPを子テーマにコピー
  2. 子テーマのPHPを編集
  3. 削除・変更箇所をコメントアウトしてから編集

といった事を習慣つけることが大事だと思います。

以上、PHPコードをコメントアウトする方法の解説でした。