WordPressで安全にコードを追加できる「Code Snippets」の使い方

※当サイトにはプロモーションが含まれています。

にゃのらいとにゃのらいと

functions.phpを編集したら、画面が真っ白になってしまったにゃ。

このブログでは、ワードプレス(WordPress)のカスタマイズ方法を多数紹介していますが、その中にはfunctions.phpの編集が必要なケースもあります。

そのためか、これまでに数件「サイトが真っ白になってしまった」というお問い合わせもいただきました。

普段からワードプレスで、Web制作をされている方ならともかく、そうでない方にとっては、functions.phpの編集は失敗しやすいのかもしれません

そこで今回は、functions.phpを直接編集せず、安全にコードを追加できるプラグイン「Code Snippets(コード スニペッツ)」の使い方を解説します。

Code Snippetsプラグインを使うメリットについて

冒頭でも触れたように、functions.phpはちょっとした記述ミスでも「サイトが真っ白」になってしまうリスクがあります。

にゃテックにゃテック

たとえば、「全角スペース」が紛れ込むだけでもエラーになってしまうにゃ。

しかし、Code Snippetsプラグインを使えば、コードにエラーがあった場合でも自動的に無効化してくれるため、「真っ白な画面」になるのを防いでくれます。

にゃのらいとにゃのらいと

その他にも以下の様なメリットがあるにゃ。

  • functions.phpを直接編集する必要がなくなる
  • コードをスニペット単位で管理できる
  • 削除せずにボタン操作で適用・非適用を切り替えられる
  • インポート・エクスポート機能で、別のワードプレスサイトへの複製も簡単
  • セーフモードを備えている

なお、似たようなプラグインとして「WPCode」がありますが、『Code Snippets』はfunctions.phpの管理に特化しているため、競合や衝突が起こりにくい利点があります。

一方で、WPCodeはより高機能で、ヘッダーやフッターへのJavaScriptやCSSの挿入、条件分岐の設定などが基本機能として利用できます。

ただし、テーマ側で用意されている機能と重複・衝突しないように注意する必要があります。

Code Snippetsプラグインの使い方について

Code Snippetsプラグインの使い方についてです。

①Code Snippetsのインストール

左メニューにある、プラグイン > 新規追加 と進み、Code Snippetsと検索します。

ハサミのマークが描かれているアイコンがあるプラグインをインストールして有効化します。

ワードプレス|Code Snippetsのインストール

②Code Snippetsの設定

設定は、初期設定(デフォルト)で問題ないと思います。

Code Snippets|設定

にゃテックにゃテック

好みによって、スペニット一覧の表示順を変えてもいいと思います。

スペニットとは?

「スニペット(snippet)」という言葉は、ITやプログラミングの世界では「小さな断片・切れ端」という意味で使われています。そのため、短いコードのような意味として考えればいいと思います。

③スペニットの作成

左メニューにある、スペニットを選択すると、初期設定のスペニットが一覧で表示されます。

使う機会がなさそうであれば、全て削除してしまって構いません。

Code Snippets|スペニット

新規追加」ボタンを押して、function.phpに記述する内容を記載します。

Locationは、コードを有効にする箇所を選ぶことができます。

Run everywhere
(サイト全体で実行)
通常の functions.php と同じ。
管理画面・フロントエンド問わず全てで実行。
管理画面のみ実行
要管理画面(/wp-admin/)でだけ実行します。
フロントエンドのみで実行
投稿・固定ページ・トップページなどの表示時にだけ実行します。
一度だけ実行
一度だけ動かしたい処理に使うのかな(初期化とか)・・・。

Code Snippets|Location

ページ下方に、コードの説明を追加する欄があるので、記載しておくと管理しやすくなります。

Code Snippets|説明

最後に「保存」もしくは「Save and Activate(保存にしてON)」ボタンを押して更新します。

スペニット一覧のトグルボタンで、ON⇔OFFを切り替えることで、適用させるコードを切り替えることができます。

Code Snippets|スペニット一覧

エラーになってしまった場合の対処法

Code Snippetsには、エラーが発生した際に自動でコードを停止してくれる機能が備わっています。

たとえば、全角文字が紛れ込むなどの単純なミスがある場合には、入力画面でエラーが表示される仕組みになっています。

Code Snippets|スペニット編集のエラー

スペニットが実行されてエラーが発生した場合

コード内に単純なエラーがある場合は、自動的にコードを停止してくれますが、他のコードと競合してエラーが発生した場合は、画面が真っ白になってしまうこともあります。

にゃのらいとにゃのらいと

管理画面も表示されないにゃ。

そういった自体に備えて、Code Snippetsにはセーフモード機能があります。

管理画面にアクセスできない状態になったら、ブラウザのアドレスバーで以下のように入力します。

https://(ドメイン名)/wp-admin/?page=snippets&snippets-safe-mode=1

なお、セーフモードでもスニペットは有効化されていますが、内部的には停止した状態となっています。

疑わしいスニペットを OFF にしてから再編集&保存してください。

Code Snippets|セーフモード

Code Snippets を使うとカスタマイズの管理がとても楽になるので、使ってみてください。