テーマのfunctions.phpへ挿入するコードを管理するプラグイン「Code Snippets」

公開日:2015年12月7日 バックエンド(管理)
Knowledge Base Wordpress プラグイン
Wordpressでサイト作りをしていると、テーマや子テーマのfunctions.phpへ追記して動作させる機会が増えてくると思います。

テーマのfunctions.phpへ追記するコードは

  1. 何かの機能を追加するコード
  2. 何かの機能を制御するコード

がほとんどで、前者はわざわざプラグインを使わなくても・・という場合に使われることが多いですし、後者はプラグインやテーマ・Wordpress本体の機能を無効にしたり、部分的に変更したりする場合に使用されます。

functions.phpも拡張子の通りphpファイルですから注釈を設けたりはできるのですが、追記したときは良くても数が増えてくると「これ何のためのコードだっけ?」「このコード使ってる?」ということに直面する、いわゆるファイルが汚れてくるということもあると思います。

「Code Snippets」は、本来直接functions.phpに記述すべきコードを投稿のように個別に管理して、有効/無効の切り替えができるようにするプラグインです。


↑はこのプラグインでコードを追加したときの管理画面(例)。本当に通常の投稿のように管理ができますね。

【Code Snippets】プラグインの基本的な機能・できること

  1. functions.phpへ直接記述することなくスニペットを管理する
  2. 作成したスニペットは「稼働」「停止」させることができる
  3. コードを保存する際にチェックが行われ、エラーのあるものは稼働しないようになっている
  4. コードを「タイトル」や「タグ」で分類することができる
  5. 設定したスニペットをエクスポート/インポートできる

前述したように「何のためのコードだっけ?」を判別しやすくなるのが一番のメリットではありますが、

  • テーマを変更したときにコードを追加(コピー)する必要がない
  • 親テーマの更新をしてもfunctions.phpが上書きされることがなく、追記した設定が台無しになるといったトラブルも回避できる

といった効果もある便利なプラグインです。

この記事の内容について
このプラグイン紹介記事は簡易的に動作テストをした上で紹介していますが以下の点にご注意願います
  1. すべての環境で動作するとは限りません
  2. できる限り最新のバージョンの情報を紹介するようにしておりますが、閲覧される時期によってはバージョンが変わり、仕様が大きく変更されている場合があります
  3. 有料版と無料版がある場合、テストは原則無料版のみで実施しています
  4. テスト環境については本文中に記載しています
  5. 使用方法で紹介しているショートコードやコードなどをコピーして使用すると、環境によっては記号などが文字化けすることがあります。コピーしたのに動作しない場合は特に「”」「’」などの記号を入力し直してみてください。

【Code Snippets】プラグインの設定画面や表示の日本語化と翻訳

当サイトで私が翻訳した【Code Snippets】プラグインの日本語化ファイルを配布しています。

翻訳ファイルは

からダウンロードできます(ダウンロードの方法や日本語の適用方法なども解説しています)

翻訳することで設定が容易になり、重要な項目の設定漏れも少なくなりますから日本語化をお勧めします。

【Code Snippets】プラグインのインストールと設定

インストール方法

インストールはプラグインの新規追加でプラグイン名で検索してインストールするか、ページ先頭の画像をクリックして表示されるWordpressのプラグイン公式配布ページがダウンロードしてからアップロードインストールします。

インストール方法の詳しい解説は

を参照ください

【Code Snippets】プラグインの基本的な使い方

インストール後は管理画面のサイドバーに「スぺニット」というハサミマークのメニューが追加されます。日本語化されていれば問題なく使用できると思います。

コードの追加や編集も通常の投稿画面のように「タイトル」と「本文(コード)」なっていますから分かりやすいと思います。

追加や編集が終わったら、「保存のみする」「保存して有効化する」「保存して無効にする」などのボタンから保存後の動作を決定します。

既存のfunctions.phpからの移行

このプラグインを使おうと思ったときにはもうすでにいくつかのコードをfunctions.phpへ追加されていると思います。そんなときにはfunctions.phpと【Code Snippets】の管理画面を両方開き、functions.phpの記述を切り取って【Code Snippets】で新規作成したスニペットへ追加して有効化していくといいと思います。重複すると不具合が発生する場合がありますから必ずコードは切り取るようにしましょう。

また、新たにコードを追加する際には、一旦テーマのfunctions.phpへ追記して動作を確認した後に【Code Snippets】へ移行するという手順にすれば、不具合が発生してもテーマのfunctions.phpをFTPなどでダウンロードして該当部分を削除し、再度アップロードすれば元に戻りますから、後述するようなトラブル回避の手間が大幅に省けると思います。

プラグイン使用時に注意したいこと

※一応エラーコードなどはチェックして稼働しないようにはなっているようですが、稼働させた際に不具合が発生して管理画面等が表示されなくなると対処に苦労するかも知れませんので、使用に際しては注意が必要かもしれません。

※他のサイトなどでも転用できるように、設定項目にある記号の閉じ子(括弧の閉じる記号や引用符の閉じる記号)を打ち忘れたときに自動で閉じ子を挿入する機能はオフにしておいた方が正しいコードの管理ができると思います。

※テーマの変更時やアップデート時に、テーマにあらかじめ同様の動作があったりすると競合して不具合が発生したりすることもあると思いますので、こうしたタイミングでは一旦すべてのスニペットを停止(プラグインの停止ではなく)してから作業を行うことをお勧めします。(プラグインの停止をしてしまうとテーマ変更してプラグインを再開したときに競合が発生する可能性がないとは言えません。)

※このプラグインにはスニペット毎にエクスポートしたり、パソコンに保存されているスニペットをインポートする機能があります。スニペットを追加した時にはバックアップ代わりにエクスポートしておくことをおすすめします。

【Code Snippets】プラグインの便利な使い方・カスタマイズ方法など

より便利に使うカスタマイズ技やテストサイトで使用した結果や感想、Wordpressのプラグイン公式配布ページには書かれていない事柄などを紹介します。

【Code Snippets】でエラーが出てしまったときは

一応プラグインの公式ページではコードのチェック機能があるようですが、Wordpress本体のコードチェック(ロールバック)機能と同じで完全ではありませんから、時にはエラーが出て画面が真っ白になってしまう・・・なんてこともあり得ます。そんなときは慌てず

を参考に復旧を行ってください。

また、いつでも復旧できるように、

  1. うまく機能した時点までのものをファイルとして保存する
  2. スニペットを個別に保存しておく

などバックアップを適時取るようにしておくことも大切だと思います

プラグインのテスト環境&個人的評価

最後に【Code Snippets】を動作確認した際の環境と個人的な評価を書いておきます。導入の検討や参考になれば幸いです。

テストした環境

  1. WordPressのバージョン:5.1.1
  2. PHPのバージョン:7.2
  3. テーマ:Simplicity2 バージョン2.6.0.9準拠のオリジナルテーマ
  4. プラグインのバージョン: 2.13.3
  5. このプラグインの最新バージョンは2.13.3です。バージョンが異なる場合には設定の仕方や動作仕様が変更になっている可能性があります。

個人的な評価・感想ほか

    5段階評価

  1. 設定のしやすさ:★★★★★
  2. 使いやすさ:★★★★★
  3. おすすめ度:★★★★★

前述したこのプラグインを使った場合に起こるトラブルの復旧方法を知っていれば、管理もしやすいし、パッとみてどの機能に関する記述なのかの判別もできるので大変便利だと思います。

Wordpressの本

Amazonの人気商品楽天市場の人気商品
CS Shop
たった1日で基本が身に付く! WordPress 超入門【電子書籍】[ 佐々木恵 ]

たった1日で基本が身に付く! WordPress 超入門【電子書籍】[ 佐々木恵 ]

1,944 円 (税込) 送料込
<p>WordPressによるWebサイト作成の基本を一から学べる書籍です。1日8時間の勤務時間内に読むことができる程度に解説内容を絞り込み,初心者・新人が最初の1冊目として読むのにふさわしい内容となっています。本書ではローカル環境にWordPressをインストールしてWebサイト..
サイトの拡張性を飛躍的に高める WordPressプラグイン開発のバイブル【電子書籍】[ 宮内 隆行 ]

サイトの拡張性を飛躍的に高める WordPressプラグイン開発のバイブル【電子書籍】[ 宮内 隆行 ]

3,456 円 (税込) 送料込
<p>プラグインの開発から運用までを網羅</p> <p>※この電子書籍は固定レイアウト型で配信されております。固定レイアウト型は文字だけを拡大することや、文字列のハイライト、検索、辞書の参照、引用などの機能が使用できません。</p> <p>CMSのデファクト・スタン..
楽天ウェブサービスセンターCS Shop

いつでもご相談・サイトカスタマイズの依頼を受け付けています

Wordpressのカスタマイズ、不具合解消のご相談はすべてココナラのダイレクトメッセージからお受けしております。まずはこちらのバナーからお気軽にお問い合わせください。

※一度もココナラを使ったことがない方はココナラへの無料登録が必要です。こちらから登録後、上のリンクをクリックする、またはココナラトップページから「ひまあーと」を検索してお問い合わせください。


【スポンサーリンク】


記事の拡散にご協力をお願いします

閲覧いただきありがとうございました。役に立つ情報でしたら是非SNSでシェアをお願いします

関連情報