この記事ではDrupalを使って開発作業をするならやっておくと良いことをいくつか紹介します。
この記事の内容
- やっておくと良い設定
- インストールしておくと良いモジュール
- 約5年間Drupal開発をおこなってきました
- カスタムテーマ、カスタムモジュールを作って
WEBサイトを構築できます。 - Drupal開発をおこなうための環境整備やその共有も経験あり
開発者としてDrupalを使った案件に携わってきた筆者が、
「これやっておくと捗るな〜」と思ったことをまとめました。
これからDrupalを使った開発をやろうとしている方や
もっと開発を効率よくおこないたい方は参考にしていただけると嬉しいです。
キャッシュの無効化
キャッシュとはユーザーがアクセスしてページに表示された情報を一定期間覚えておくことでページの表示時間を早くする機能です。
Drupalではさまざまなキャッシュが効いているためテーマやモジュールを開発中に有効化していると、
「ソースコードを修正したのに反映されない」「設定を変更したのに反映されない」といったことが発生することがあります。
そのため開発中はキャッシュを無効化することで開発作業を効率よくおこなうことができます。
設定手順
管理者権限を持つユーザーでログインし、
上部の管理者メニューの環境設定 > 開発 > 開発設定にアクセスします。
※<ドメイン>/admin/config/development/settings
下図のような画面が表示されますので、
以下全てのチェック項目にチェックを入れて保存します。
- Twig開発モード
- Twig debug mode
- Twigキャッシュを無効にする
- マークアップをキャッシュしない
注意書きもされているように、
これらの設定は本番環境では実施しないようにしてください。
本番環境ではキャッシュを有効にしてユーザーの利便性を高めることが推奨されます。
テンプレートサジェッションを使おう
テンプレートサジェッションとは
カスタムテンプレートを作成するときの命名ヒントをページのHTMLにコメントとして出力してくれる機能です。
前述の開発設定を有効化すると以下のようにページのHTMLに
どのようなテンプレート名であれば使用できるかをDrupalが出力してくれます。
上図の場合、html.html.twigをカスタマイズしたい時は
以下のいずれかのファイル名であればテンプレートが使用できることが表示されています。
- html–front.html.twig
- html–node.html.twig
- html.html.twig
なおファイル名は上から順番に優先されます。
開発者向けモジュールをインストール
Admin Toolbar
Admin Toolbarモジュールは管理者メニューをドロップダウンで表示するモジュールです。
サイト構築や環境設定は下層ページが多いためリンクを辿るのが大変ですが、
Admin Toolbarモジュールであればホバーするだけで下層ページへのリンクを表示してくれます。
そのため下層ページへも効率的にアクセスできるようになります。
Devel Kint Extras
Devel Kint ExtrasはKintと呼ばれるPHPのデバッグツールを使用できるモジュールです。
フックファイルに以下のようにコードを記載すると変数の値が確認できます。
$test = "This is a the test."
kint($test);Examples for Developers
Examples for Developersはカスタムモジュールのサンプルコードを提供してくれるモジュールです。
ソースコードだけでなくどのようなアウトプットが出来上がるのかも確認できます。
カスタムモジュールの作り方に関する記事でもご紹介していますのでぜひご覧ください。
さいごに
いかがでしたでしょうか。
この記事はDrupalで開発をおこなうときにやっておきたい3つのことをご紹介しました。
・キャッシュの無効化
・テンプレートサジェッションを使う
・開発者向けモジュールを使う
この記事を参考に効率的にDrupal開発をやってみてください！