Code Snippets

説明

Code Snippets は、WordPress サイトで PHP コードスニペットを実行するための簡潔でシンプルな解決法です。このプラグインを有効化すると、テーマの functions.php ファイルにカスタムスニペットを追加する必要がなくなります。

Code Snippets Pro is now available, with full CSS, JavaScript, Gutenberg and Elementor integrations.

スニペットとは、WordPress サイトの機能を拡張するための PHP コードの小さな塊を指します。サイトへの負荷が少ないミニプラグインとも言えるでしょう。

スニペットを掲載・紹介する多くのウェブサイトでは、有効化されているテーマの functions.php ファイルにコードを追加する作例が示されます。しかし、コードを追加するたびファイルの記述は長くなり、管理が面倒になることがしばしば起こります。

Code Snippets を使うと、グラフィカルなインターフェースを通じてスニペットを追加できます。追加したスニペットはテーマの functions.php ファイルに追加したコードのように、実際にサイト上で実行させることができます。

Imran Siddiq による Code Snippets の概要紹介

Code Snippets を使うと、プラグインメニューに似たグラフィカルなインターフェースでスニペットを管理できます。また、スニペットはプラグインと同様、有効化 / 無効化することもできます。

スニペット管理画面には、スニペットの名前、ビジュアルエディタ対応の説明、スニペットを分類するためのタグ、コードエディター用の入力フィールドなどが含まれています。JSON 形式のエクスポート / インポート機能を使って、スニペットを他のサイトに移設することもできます。エクスポートの時に PHP 形式を選べば、独自のプラグインやテーマを作成する際の土台としても活用できます。

Ferdy Korpershoek による、総合的な Code Snippets のチュートリアルと実践例

If you have any feedback, issues, or suggestions for improvements please leave a topic in the Support Forum, join the community on Facebook, or check us out on GitHub.

このプラグインが気に入ったり、あなたの役に立ったりしたときには、WordPress.org でレビューすることを検討してください。

翻訳

Code Snippets は、次の翻訳者のおかげで、これら異なる言語で使用できます:

スクリーンショット

  • 既存のスニペットの管理
  • 新しいスニペットを追加する
  • スニペットを編集する
  • エクスポートファイルからスニペットをインポート

インストール

自動インストール

  1. WordPress 管理画面にログイン
  2. プラグインをクリック
  3. 新規追加をクリック
  4. Code Snippets の検索
  5. “Code Snippets” の下の「今すぐインストール」をクリック
  6. プラグインを有効化する

手動インストール

  1. プラグインをダウンロードする
  2. ZIP ファイルの中身を取り出す
  3. Zip ファイルの内容を WordPress インストールの wp-content/plugins/ フォルダにアップロード
  4. 「プラグイン」ページで Code Snippets プラグインを有効化

サイトネットワーク管理画面で Code Snippets を「ネットワークで有効化」すると、スニペット編集画面にネットワーク全体でスニペットを実行するための設定項目が現れます。

FAQ

よくある質問の全リストは、help.codesnippets.pro でご覧いただけます。

スニペットのバグでサイトに不具合が起きたときの復帰方法を教えてください。

Code Snippets のセーフモード機能を有効にすると、サイトの動作を復旧させることができます。有効化の方法については次のリンク先を参照してください: https://help.codesnippets.pro/article/12-safe-mode

テーマを変えたり WordPress をアップグレードしたりすると、作成したスニペットは失われますか ?

いいえ、スニペットはテーマとは無関係に WordPress データベースに保存され、WordPress のアップグレードの影響を受けません。

プラグインを完全にアンインストールすることはできますか ?

プラグインの設定ページで「プラグイン削除時の処理」オプションを有効にすると、WordPress の「プラグイン」メニューから Code Snippets を削除した時に、Code Snippets のすべてのデータがクリーンアップされます。このデータには保存済みのすべてのスニペットが含まれます。スニペットをバックアップしておきたい場合は、まずスニペットをエクスポートしてください。

作成したスニペットを別の WordPress サイトにコピーできますか ?

はい ! 「スニペット一覧」ページのスニペット名の下にあるリンクからスニペットを個別にエクスポートしたり、「一括操作」機能で複数のスニペットを一括エクスポートしたりすることができます。エクスポートしたファイルは「インポート」ページでインポートすることもできます。

Code Snippets プラグインを使っていないサイトでスニペットを使いたいです。作成したスニペットを PHP コードとしてエクスポートできますか ?

はい。使いたいスニペットの横にあるチェックボックスをクリックし、「一括操作」メニューから「ダウンロード」を選択して「適用」をクリックします。生成された PHP ファイルには、エクスポートされたスニペットのコードのほか、スニペットのタイトルと説明がコメントとして含まれます。

マルチサイト環境において、スニペットをネットワーク全体で実行することはできますか ?

ネットワークダッシュボードから Code Snippets をネットワーク起動することで、マルチサイトネットワーク全体でスニペットを実行することができます。また、メインサイトだけで Code Snippets を有効にして、他のお好きなサイトで個別に有効にすることもできます。

WordPress データベースのどこにスニペットが保管されているのでしょうか?

スニペットは WordPress データベースの wp_snippets テーブルに格納されます。テーブル名は、テーブルのプレフィックスの設定によって異なる場合があります。

ヘルプや新機能について提案したいときはどうすればよいですか ?

You can get help with Code Snippets, report bugs or errors, and suggest new features and improvements either on the WordPress Support Forums or on GitHub

Code Snippets プラグインの開発に貢献するにはどうすればよいですか ?

The best way to do this is to fork the repository on GitHub and send a pull request.

評価

2023年9月24日 1 reply
Code Snippets certainly deserves 5 stars, I have been using it for a few years now and very happy with this plugin and the support for it. The easiest way I have found to shortcut a number of processes instead of having to edit many files to get a few things setup the way you want them, one of the main snippets I use it for is to delete the images associated to a product when the product itself is deleted, much more reliable than other plugins that claim to do the same.
2023年9月5日
I've been using this plugin for a few years now and it's been great. If you need to add custom code to your site without having to modify your theme, child theme, or plugin this is the way to go.
423件のレビューをすべて表示

貢献者と開発者

Code Snippets はオープンソースソフトウェアです。以下の人々がこのプラグインに貢献しています。

貢献者

“Code Snippets” は22ロケールに翻訳されています。 翻訳者のみなさん、翻訳へのご協力ありがとうございます。

“Code Snippets” をあなたの言語に翻訳しましょう。

開発に興味がありますか ?

コードを閲覧するか、SVN リポジトリをチェックするか、開発ログRSS で購読してみてください。

変更履歴

3.5.0 (14 Sep 2023)

  • Added: Support for the Code Snippets Cloud API.
  • Added: Search and download public snippets.
  • Added: Codevault back-up and synchronisation. (PRO)
  • Added: Synchronised local snippets are automatically updated in Cloud. (PRO)
  • Added: Bulk actions – ‘update’ and ‘download’.
  • Added: Download snippets from public and private codevaults. (PRO)
  • Added: Search and download any publicly viewable snippet in Code Snippet Cloud by keyword or name of codevault. (PRO)
  • Added: Deploy snippets to plugin from Code Snippets Cloud app. (PRO)
  • Added: Bundles of Joy! Search and download Snippet Bundles in one go direct from Code Snippets Cloud. (PRO)
  • Fixed: Error when attempting to update network shared snippets after saving. [#]
  • Improved: Redirect to snippets table when deleting snippet from the edit menu.
  • Improved: Scroll new notices into view on edit menu.

3.4.2 (05 Jul 2023)

  • Fixed: Issue causing export process to fail with fatal error. [#]
  • Fixed: Type issue on the_posts filter when no posts available. [#]

3.4.1 (29 Jun 2023)

  • Fixed: Undefined array key error. [#]
  • Fixed: Potential type issue when loading Prism. [#]
  • Improved: Added better debugging when calling REST API methods from the edit menu.
  • Improved: Escape special characters when sending snippet code through AJAX to avoid false-positives from security modules. [#]
  • Improved: Only display the latest update or error notice on the edit page, instead of allowing them to stack.
  • Fixed: Potential type issue when sorting snippets. [#]
  • Fixed: Issue preventing asset revision numbers from updating correctly. (PRO) [#]

3.4.0 (17 May 2023)

  • Added: Proper WordPress REST API support for retrieving and modifying snippets.
  • Improved: Better compatibility with modern versions of PHP (7.0+).
  • Improved: Converted Edit/Add New Snippet page to use React.
    • Converted action buttons to asynchronously use REST API endpoints through AJAX.
    • Load page components dynamically through React.
    • Added action notice queue system.
    • Replaced native alert dialog with proper React modal.
  • Improved: Catch snippet execution errors to prevent site from crashing.
  • Improved: Display recent snippet errors in admin dashboard instead.
  • Improved: Updated editor block to use new REST API endpoints. (PRO)
  • Improved: Change colour of upgrade notice in Pro plugin. (PRO)
  • Improved: All available snippet data is included in export files.
  • Improved: Only import specific fields from export file, even if additional fields specified.
  • Fixed: Issue preventing editor colorpicker from loading correctly. (PRO)
  • Improved: Added help links to content snippet options.
  • Improved: Pass additional attributes specified in [code_snippet] content shortcode to shortcode content.
  • Improved: Make shortcode attributes available as individual variables.
  • Improved: Allow boolean attributes to be passed to code snippets shortcodes without specifying a value.
  • Improved: Replace external links to Pro pricing page with an upgrade modal.
  • Fixed: Issue preventing linting libraries from loading correctly in the code editor.

3.3.0 (09 Mar 2023)

  • Fixed: Do not enqueue CSS or JS snippet file if no snippets exist. (PRO)
  • Improved: Added additional editor shortcuts to list in tooltip.
  • Added: Filter for changing Snippets admin menu position. See this help article for more information.
  • Added: Ability to filter shortcode output. Thanks to contributions from Jack Szwergold.
  • Fixed: Bug causing all snippets to show in site health information instead of those active.
  • Fixed: Unnecessary sanitization of file upload data causing import process to fail on Windows systems.

3.2.2 (17 Nov 2022)

  • プラグイン起動時にヘッダーエラーが発生する不具合を修正した。

3.2.1 (05 Oct 2022)

  • アンケートリマインダーの通知が解除できない問題を解消した。
  • スニペットエディターでコードをコメントアウトするとき、Ctrl+/Cmd+/ をキーボードショートカットとして使えるようにした。
  • さまざまなスニペットアクションへのフックを追加した (ancient-spirit の貢献に感謝)。
  • スニペットエディターに折りたたみマーカー、キーボードショートカット、キーマップオプションを追加した (Amaral Krichman の貢献に感謝)。
  • 重複して存在するテーブルのクエリを削除した (# を参照)。
  • コンテンツスニペットの新規作成時、「段落と書式を追加する」オプションをデフォルトで有効にするようにした。
  • スニペットの取得、有効化、無効化、削除、作成、更新、エクスポート、インポートを実行する WP-CLI コマンドを追加した。
  • プロ版の更新時に表示されるパスを修正した。

3.2.0 (22 Jul 2022)

  • SQL カラムのデフォルト値を削除し、特定バージョンの MySQL における互換性を改善した。
  • Gutenberg エディターブロックにおけるスニペットの遅延読み込みを修正した (プロ版)。
  • Gutenberg エディターのソースコードブロックに、行番号の表示 / 非表示オプションを追加した (プロ版)。
  • HTML、CSS、JS、埋め込みコードをフロントエンドの Prism JS コードハイライターに対応させた。
  • フロントエンドの Prism JS コードハイライターに自動リンクやコピーボタンなどを追加した。
  • Gutenberg エディターのソースコードブロックについて、複数のコードスタイルに対応した (プロ版)。
  • Code Snippets プロ版の更新をサイト管理者に知らせる機能を追加した
  • 異なるバージョン間における翻訳の不一致を修正した。
  • コンテンツスニペットのショートコード情報が表示されない問題を修正した。
  • ショートコードのテキストをクリップボードにコピーするボタンを追加した。
  • Code Snippets の CSS と JS のソースコードを配布パッケージに含めるようにした。
  • Code Snippets プロ版を有効化した状態で Code Snippets 無料版を削除しても、プラグインのデータを削除しないようにした。
  • Gutenberg エディターブロックのユーザーインターフェースを改良した (プロ版)。
  • ソースエディターブロックと Elementor ウィジェットの Prism コードハイライタについて、44種類のテーマから選べるオプションを追加した (プロ版)。
  • Elementor ウィジェット最新バージョンとの互換性を改善した (プロ版)。
  • アイコンフォントメニューのアイコンを埋め込み SVG アイコンに置換した。

3.1.2 (03 Jul 2022)

  • Code Snippets プロ版への外部リンクと表記を更新した。
  • 設定ページにおいて、ページ内ナビゲーションの代わりにリンク URL を追加した。
  • ブロックエディターが使用するスクリプトを修正した (プロ版)。
  • Gutenberg エディターにおけるブロックのスタイルを改善した (プロ版)。

3.1.1 (13 Jun 2022)

  • スニペットをダウンロードした時に、スニペットのコンテンツが含まれない問題を修正した。
  • 「外部で開く」アイコンの表示位置のずれを修正した。
  • code_snippets/export/filename フィルターに追加のパラメータを追加した。

3.1.0 (17 May 2022)

  • キャッシュ不整合が原因となり、永続的なオブジェクトキャッシュを使用するサイトでスニペットや設定が更新されない問題を修正した
  • データベースにアクセスする際のクエリーを簡素化した。
  • 有効化したスニペットにも作用する、従来より包括的なキャッシュ機能を追加した。
  • 「プロ版 (Go Pro)」ボタンに、新しいタブを開くことを示すアイコンを追加した。
  • スニペットの説明文にスタイルを適用できるようにした。

3.0.1 (14 May 2022)

  • 以前のバージョンの PHP との互換性問題を修正した。

3.0.0 (14 May 2022)

追加:

  • ショートコードとして使用したり、ページのヘッダーやフッターとして表示したりするための HTML コンテンツスニペットを追加した。
  • 非サポートの PHP を使用する環境で PHP のアップグレードを促す通知を出すようにした。
  • ショートコードに属性を追加するための設定項目を設けた。
  • 投稿や固定ページの編集画面に挿入できるよう、ショートコードボタンを追加した。
  • 基本的な REST API のエンドポイントを追加した。
  • スニペット一覧ページにスニペットタイプを示す欄を追加した。
  • スニペット編集ページに、編集中のスニペットタイプのバッジ (小さなアイコン) を表示する機能を追加した。
  • コードエディターのハイライト表示に関する設定項目を追加。現在行のハイライト表示 / 非表示を切り替えられるようにした。
  • タイトルやコードのないスニペットを保存しようとした際、警告を表示する機能を追加した。
  • スニペットを複製した際、スニペットのタイトルにサフィックスを追加するようにした。

変更:

  • プラグインのコードを改良。名前空間を導入し、他のプラグインとの名前の衝突を防ぐように改善した。
  • データベーステーブルの active カラムと scope カラムにキーを追加し、クエリーを高速化するように改善した。
  • 正しく記述されたスニペットを編集していないとき、編集メニューからリダイレクトするように改善した。
  • スニペット一覧ページに表示される、スニペット有効化 / 無効化の切り替えスイッチを移動した。
  • WordPress 標準に従ってコードのドキュメントを更新した。
  • スニペット一覧ページのタブに、スニペットのタイプを示すラベルを追加した。
  • プラグイン設定ページの設定項目をタブで分類するように改善した。
  • WordPress 同梱の CodeMirror をできるだけ使用し、内蔵されている機能を継承するよう改善した。
  • スニペット編集画面の優先度設定欄にホバー効果を追加し、編集可能であることを明示するようにした。
  • 小さなサイズの画面でスニペット一覧を表示した際のテーブルレイアウトを修正した。

非推奨:

  • サポート外となったバージョンの PHP で使われていた非推奨の関数など、互換性に影響のあるコードを除去した。
  • スニペットを適用しない範囲を指定するオプション項目を削除した。

プロ版の新機能

  • フロントエンドと管理画面にスタイルスニペット (CSS) を挿入できる機能を追加した。
  • フロントエンドの head セクションと body セクションに JavaScript スニペットを挿入できる機能を追加した。
  • CSS スニペットおよび JavaScript スニペットについて、ブラウザキャッシュのバージョン管理機能を追加した。
  • CSS スニペットおよび JavaScript のスニペットのエクスポート機能を追加した。
  • フロントエンドでのコードのハイライト表示に対応した。
  • CSS、JavaScript、HTML 編集時のシンタックスハイライト機能を追加した。
  • CSS スニペットおよび JavaScript スニペットの編集時、ファイル全体をプレビューできるボタンを追加した。
  • CSS スニペットおよび JavaScript スニペットの圧縮オプションを追加した。
  • コンテンツスニペットを表示する Gutenberg ブロックを追加した。
  • スニペットのコードを表示する Gutenberg ブロックを追加した。
  • コンテンツスニペットを表示するための Elementor ウィジェットを追加した。
  • スニペットのコードを表示する Elementor ウィジェットを追加した。

The full changelog is available on GitHub