IM Base – incディレクトリガイド
【公開準備中】 IM Baseは現在、一般向けの正式公開に向けて準備を進めています。テーマのダウンロードおよび提供方法については、準備が整い次第ご案内します。
このページでは、IM Baseのincディレクトリに格納されているPHP機能モジュールと、それぞれの責務や設計上の役割分担について開発者向けに説明します。
概要
incディレクトリには、IM Baseの各機能を実装するPHPモジュールと、再利用可能なPHPクラスが格納されています。
現在のモジュールは、ナビゲーションのHTML生成、共通ヘルパー関数、CSS・JavaScriptの読み込み、レイアウト制御、投稿一覧、SEO、サイトマップ、ショートコード、目次(Table of Contents)、Newsカスタム投稿タイプなどを担当しています。
また、制作者が独自のCSSやJavaScriptを登録するためのenqueue-custom.phpも含まれています。
functions.phpは、各モジュールを決められた順序で読み込む役割を持ちます。
管理画面関連ファイル、Core関連ファイル、inc内のモジュール、Newsカスタム投稿タイプなどをrequire_onceで読み込みます。
機能そのものの実装はfunctions.phpにまとめず、それぞれのモジュール内に配置します。
class-imb-global-nav-walker.phpcustom-functions.phpenqueue.phpenqueue-custom.phpenqueue-singular-css.phplayout.phppost-list-layout.phpseo.phpshortcodes.phpsitemap.phptable-of-contents.phpcustom-post-types/news.php
incディレクトリの読み込み方法
functions.phpでは、テーマのPHPファイルを次の4つのグループに分けて読み込みます。
- Admin:テーマ設定、レイアウト、SEO、目次に関連するメタボックスのモジュール。
- Core:
core/setup.phpとcore/cleanup.php。 - Theme Functions:共通ヘルパー、ナビゲーションWalker、ショートコード、アセット、レイアウト、SEO、サイトマップ、目次などのモジュール。
- Custom Post Types:Newsカスタム投稿タイプのモジュール。
この読み込み順序は、各ファイルを読み込む順番を示すものであり、各モジュールが実行時に行うすべての処理順序を示すものではありません。
core/setup.phpは、after_setup_themeフックを通じて、テーマサポートの登録、テキストドメインの読み込み、Global NavigationとFooter Navigationの表示位置の登録を行います。
inc内のモジュールには、機能の実装、ヘルパー関数、フック、フィルター、再利用可能なクラスなどが含まれます。
functions.phpは、これらを適切な順序で読み込む責務に限定します。
require_once get_theme_file_path('/inc/custom-functions.php');
require_once get_theme_file_path('/inc/shortcodes.php');
require_once get_theme_file_path('/inc/enqueue.php');
各ファイルの役割
class-imb-global-nav-walker.phpは、Walker_Nav_Menuを継承したIMB_Global_Nav_Walkerクラスを使って、ナビゲーションのHTMLを生成します。
custom-functions.phpには、サイト画像や事業者情報を取得するための再利用可能なヘルパー関数が用意されています。
enqueue.phpは、wp_enqueue_scriptsフックでwp_enqueue_style()とwp_enqueue_script()を使用し、テーマ標準のフロントエンドCSSとJavaScriptを読み込みます。
enqueue-custom.phpは、同じフックの優先度20で制作者が定義したアセットを読み込みます。
enqueue-singular-css.phpは、優先度30で個別コンテンツ用のオプションCSSを読み込みます。
layout.phpは、レイアウト設定の取得・判定に加えて、カラム構成、ヘッダー、スクロール位置のオフセット、モバイル操作ボタン、bodyクラス、サイドバーなどのヘルパーを提供します。
また、wp_enqueue_scriptsでスクロールオフセット用CSSやカスタムレイアウトCSSを追加し、body_classを通じてレイアウト用クラスを付与します。
post-list-layout.phpは、アーカイブの投稿一覧に関するタイトル、説明文、設定、描画処理を提供します。表示にはtemplate-parts/post-listテンプレートを使用します。
seo.phpは、テーマ標準のメタタグ、Open Graph情報、canonical URL、構造化データを担当します。
wp_headやwpなどのフックを利用し、SEOプラグインが導入されている場合の判定も行います。
sitemap.phpは、投稿タイプ、タクソノミー、投稿取得クエリの引数、サイトマッププロバイダーに関するフィルターを使い、WordPress標準のXMLサイトマップを調整します。
shortcodes.phpは、initフックで次のショートコードを登録します。
また、テンプレートパーツの出力を取得し、ショートコードの表示に利用する機能も備えています。
table-of-contents.phpは、目次(TOC)の設定、見出しの抽出と処理、リストの生成、ショートコード、the_contentによる本文処理、wp_footerで出力するモバイル用ドロワーなどを担当します。
custom-post-types/news.phpは、initフックでNewsカスタム投稿タイプを登録します。
また、add_meta_boxesで外部リンク用のメタボックスを追加し、News投稿の保存時にはsave_postを利用して外部URLを保存します。
- ナビゲーションのHTML生成:
class-imb-global-nav-walker.php - サイト画像・事業者情報の取得:
custom-functions.php - 標準・独自・個別ページ用アセットの読み込み:
enqueue.php、enqueue-custom.php、enqueue-singular-css.php - レイアウトと投稿一覧:
layout.php、post-list-layout.php - メタデータ・構造化データ・XMLサイトマップ:
seo.php、sitemap.php - ショートコードとテンプレートパーツの出力:
shortcodes.php - 目次の処理と表示:
table-of-contents.php - News投稿タイプと外部リンク情報:
custom-post-types/news.php
よく使うカスタマイズ箇所
IM Baseをカスタマイズする場合は、変更したい機能の責務を持つファイルを確認してください。
CSS・JavaScriptの読み込み
テーマ標準のCSSとJavaScriptの読み込みは、inc/enqueue.phpで管理します。
制作者が独自に追加するファイルは、inc/enqueue-custom.phpで扱います。
CSSファイルはassets/css/、JavaScriptファイルはassets/js/に配置し、拡張子を除いたファイル名を指定します。
個別の固定ページや投稿のスラッグに対応するCSSは、inc/enqueue-singular-css.phpとassets/css/singular/配下のファイルで管理します。
レイアウトとサイドバー
カラム構成、サイドバーの動作、レイアウト設定、bodyクラス、スクロールオフセット用CSS、カスタムレイアウトCSSは、inc/layout.phpで管理します。
ショートコード
サイトロゴ、事業者情報、パンくずリスト、News一覧、SNSリンク、共有ボタン、テンプレートパーツの出力などに関するショートコードは、inc/shortcodes.phpで登録・処理します。
SEOとサイトマップ
XMLサイトマップの調整はinc/sitemap.phpが担当します。
サイト画像と共通の事業者情報の取得処理はinc/custom-functions.phpにあります。
News投稿タイプの登録と外部URLフィールドはinc/custom-post-types/news.phpで管理します。
アーカイブの投稿一覧に関するタイトル、説明文、設定、描画処理はinc/post-list-layout.phpにあります。
テーマ標準のメタデータと構造化データはinc/seo.phpが担当します。
目次とナビゲーション
目次の設定、見出しの抽出、表示処理、ショートコード、本文フィルター、モバイル用ドロワーは、inc/table-of-contents.phpが担当します。
グローバルナビゲーションの各項目のHTMLは、inc/class-imb-global-nav-walker.phpで生成されます。
- 標準CSS・JavaScriptの読み込み:
inc/enqueue.php - 独自アセットの登録:
inc/enqueue-custom.php - スラッグ別CSSの読み込み:
inc/enqueue-singular-css.php - カラム・サイドバー・レイアウトCSS変数:
inc/layout.php - ショートコードの登録と表示:
inc/shortcodes.php - XMLサイトマップの対象設定:
inc/sitemap.php - 事業者情報・サイト画像の取得:
inc/custom-functions.php - News投稿タイプ・外部URLフィールド:
inc/custom-post-types/news.php - アーカイブ一覧の見出し・説明・設定・描画:
inc/post-list-layout.php - メタタグ・構造化データ:
inc/seo.php - 目次の抽出・表示・ショートコード・本文フィルター・ドロワー:
inc/table-of-contents.php - グローバルナビゲーションのHTML:
inc/class-imb-global-nav-walker.php
各ディレクトリの責務と役割分担
core/setup.phpは、テーマサポートの宣言、テキストドメインの読み込み、ナビゲーション表示位置の登録など、WordPress Coreとの連携を担当します。
functions.phpは、Admin、Core、Theme Functions、Custom Post Typesの各モジュールを決められた順序で読み込む役割に限定します。
機能の実装をfunctions.phpに直接追加するのではなく、担当するモジュールに配置してください。
inc/には、ナビゲーション、ショートコード、レイアウト、SEO、サイトマップ、目次などのPHP機能、ヘルパー、フック、フィルター、再利用可能なクラスを配置します。
template-parts/には、テンプレートやヘルパーから呼び出す再利用可能な表示用テンプレートを配置します。
assets/には、SCSSソース、生成済みCSS、JavaScript、画像、アイコンなど、ブラウザ側で使用するリソースを配置します。
core/setup.php:テーマサポート、テキストドメイン、ナビゲーション表示位置の登録。functions.php:決められた順序でのモジュール読み込み。inc/:PHP機能、ヘルパー、フック、フィルター、再利用可能なクラス。template-parts/:テンプレートやヘルパーから呼び出す共通の表示用テンプレート。assets/:SCSS、生成済みCSS、JavaScript、画像などのブラウザ用ファイル。
新しいPHP機能を追加する方法
新しいPHP機能を追加する場合は、まずWordPress Coreに適切なAPI、フック、テンプレート関数、データ構造が用意されていないか確認してください。
独自の実装が必要な場合は、inc配下に機能単位のモジュールを作成し、PHP識別子にはimb_プレフィックスを使用します。
各モジュールの責務は、できるだけ限定的で分かりやすいものにしてください。
新しいモジュールは、functions.phpからrequire_onceとget_theme_file_path()を使って読み込みます。
既存のモジュール読み込み順序と構造を維持してください。
アクションやフィルターの登録は、それぞれの機能モジュール内で行います。functions.phpを機能実装用のファイルにしないでください。
まとまった量の表示用HTMLが必要な場合は、template-parts/に配置し、機能モジュールやテンプレートから呼び出す構成にします。
モジュール読み込みの例
require_once get_theme_file_path('/inc/sitemap.php');
機能モジュールの例
function imb_filter_sitemap_post_types($post_types)
{
$allowed_post_types = ['page', 'post', 'news'];
return array_intersect_key($post_types, array_flip($allowed_post_types));
}
add_filter('wp_sitemaps_post_types', 'imb_filter_sitemap_post_types');