Modules /05

GRM Core

GRMシリーズ全体の土台となる共通モジュール。管理画面のヘッダー・タブ・ボタンや、画像・ギャラリー・カレンダーなどの入力部品を提供し、どのプラグインも同じ操作感で使えるようにしています。

Version
2.2.4
Slug
grm-core

Overview

すべてのGRMを、
同じ操作感で。

GRM Coreは、GRMシリーズ全体の土台になる共通モジュールです。管理画面のヘッダー・タブ・ボタンといった見た目から、画像・ギャラリー・日付・繰り返し項目などの入力部品まで、各プラグインが共通で使う部品をまとめて提供しています。

どのGRMプラグインも同じ部品で作られているので、操作方法がそろい、覚えることが少なくて済みます。部品の改善や不具合の修正もGRM Core側で行えば、すべてのプラグインにまとめて反映されます。

Features

  • 共通の管理画面デザインロゴ入りのヘッダー、タブ、保存・追加・削除などの色分けされたボタンを、すべてのGRMプラグインで共通化しています。各プラグインは grm_core_enqueue_admin_assets() を呼ぶだけで読み込めます。
  • 16種類の入力フィールドテキスト・テキストエリア・数値・日付・セレクト・ラジオ・チェックボックス・ON/OFFスイッチ・画像・ファイル・動画・ギャラリー・グループ・アコーディオン・リピーターなどを、GRMCORE_Field_*::render() ひとつで表示できます。
  • プラグインの一覧と対応状況GRMプラグインは有効化すると自動でGRM Coreに登録され、ダッシュボードにバージョン、GRM Coreへの対応状況、使っている入力フィールドが一覧表示されます。
  • 共通パーツの見本とガイドボタン・ページネーション・モーダル・トースト(通知)の見本と、各フィールドの書き方・保存形式・用途をまとめたガイドを、管理画面で確認できます。
  • 無効時の案内GRM Coreが無効になっている場合は、各プラグインの管理画面に「GRM Coreを有効化してください」という案内を表示し、画面が崩れたまま使われることを防ぎます。

Screens

GRM Coreのダッシュボード
ダッシュボード。登録されているGRMプラグインの数とバージョン、GRM Coreへの対応状況、使っている入力フィールドを一覧で確認できます。
共通の入力フィールド
共通の入力フィールド。テキスト・日付・セレクト・ラジオ・チェックボックスなどを、どのプラグインでも同じ見た目・操作で使えます。
グループ・アコーディオン・リピーター
グループ・アコーディオン・リピーター。項目をまとめたり、行を追加してドラッグで並び替えたりする入力も、共通の部品で作れます。
共通パーツの見本
共通パーツの見本。保存・追加・削除などのボタンの色分け、ページネーション、モーダル、トーストを確認できます。
GRM Coreのガイド
ガイド。各フィールドの呼び出し方・保存形式・用途を、コード付きでまとめています。

How to use

  1. 有効化するGRM Coreを有効化します。GRMシリーズの各プラグインを使う前に有効にしておきます。
  2. 各プラグインを有効化GRM Core対応のプラグインを有効化すると、自動でGRM Coreに登録され、共通の管理画面デザインと入力部品で表示されます。
  3. 対応状況を確認管理メニュー「GRM Core」のダッシュボードで、登録されたプラグインのバージョンと対応状況を確認します。
  4. プラグインを作るときadmin_enqueue_scripts で grm_core_enqueue_admin_assets() を呼び、入力欄は GRMCORE_Field_Text::render() などで表示します。書き方は「Guide」タブにまとめています。

Spec

役割GRMシリーズ共通の土台(管理画面デザイン・入力フィールド・プラグインの登録と一覧)
入力フィールドtext ・ textarea ・ number ・ date ・ select ・ radio ・ checkbox ・ checkbox_single ・ true_false ・ image ・ file ・ video ・ gallery ・ group ・ accordion ・ repeater
主な関数grm_core_register_plugin()
grm_core_enqueue_admin_assets()
grm_core_render_missing_notice()
GRMCORE_Field_*::render()
共通ボタン保存 ・ 追加 ・ 編集 ・ 複製 ・ 削除 ・ 並び替え ・ キャンセル/戻る
GRM Core無効時対応プラグインの管理画面に有効化の案内を表示

Start a Project

つくりたいサイトのこと、聞かせてください。
必要な仕組みを、モジュールでかたちにします。

Tell us about the site you want to build.
We turn your ideas into modules that just work.

Get in Touch