本文へ移動
STUDIO UMI
UMI BLOGウミブログ
ともに働く仲間を募集中 フルリモート勤務。Drupal に興味のある方大歓迎!

Drupal 7 のコアが提供するすべてのフック一覧

Studio Umi

本日は Drupal 7 のコアが提供するフックの一覧を日本語に訳してご紹介できればと思います。

本題に入る前に、「フック」という概念に馴染みの薄い方のためにプチ解決を試みてみます。

「フック」というのは英語の hook のことで、日本語にもなっている「何かをひっかけるもの」という意味のことばです。 「フック船長」のフックと同じですね。

このことばは Drupal や WordPress などの CMS の世界では「コアのシステムに変更を加えずに何らかの処理をはさみこむ仕組み」のことを指します。 そして Drupal の開発では所定のフックに対して処理を追加することを「◯◯フックを実装する」( Implement xx hook )と呼んだりします。 Drupal のフックについては過去に解説記事を書いていますので興味がある方はそちらもご覧いただければと思います。

Drupal の開発では特に追加コードの「すべてがモジュール」であり「すべてがフック実装」と言っても過言ではないので、「どれだけ多くのフックを知っていて使いこなせるか」という言うならば「フックリテラシー」のようなものがそのままその人/その開発会社の Drupal 開発力につながってくるところがあります。

そんな Drupal 開発において非常に重要概念であるフックですが、 Drupal コアが提供するフックについての網羅的な情報源は日本語ではまだ存在しないというのが現状のようです。 私たち自身もそうですし、私たち以外の日本における Drupal 開発者にとってこのあたりは非常に重要な情報になってくるかと思いますので、この度翻訳を試みてみました。 適切なフック探しのご参考にしていただければと思います。

なお、翻訳元の情報源は Drupal.org の以下のページです。 2015 年 05 月現在の情報をもとにしてます。

Drupal のフックはコアが提供しているものだけでも数百もの数がありますので、以下の一覧テーブルはものすごい長さになっています。 すべてをひとつひとつ見ていくとキリがないくらいなので、適当にページ内検索をしてお使いいただければと思います。

翻訳は直訳/意訳を織り交ぜたものになっていますので、精確な意味を知りたい方は原文もしくは各フックの説明ページにさかのぼってみていただければと思います。

名前場所説明
hook_field_storage_writemodules/field/field.api.phpエンティティのフィールドデータを記述する。
callback_queue_workermodules/system/system.api.php単一のキューアイテムについて処理を行う。
hook_actions_deletemodules/system/system.api.phpアクションが削除された後にコードを実行する。
hook_action_infomodules/system/system.api.phpアクションについての情報を宣言する。
hook_action_info_altermodules/system/system.api.php他のモジュールが宣言したアクションについての情報を変更する。
hook_admin_pathsmodules/system/system.api.php管理用パスを定義する。
hook_admin_paths_altermodules/system/system.api.php他のモジュールが定義した管理用パスを変更する。
hook_aggregator_fetchmodules/aggregator/aggregator.api.phpAggregator モジュールのフェッチャーを作成する。
hook_aggregator_fetch_infomodules/aggregator/aggregator.api.php定義したフェッチャーのタイトルと説明を指定する。
hook_aggregator_parsemodules/aggregator/aggregator.api.phpAggregator モジュールのパーサーを作成する。
hook_aggregator_parse_infomodules/aggregator/aggregator.api.php定義したパーサーのタイトルと説明を指定する。
hook_aggregator_processmodules/aggregator/aggregator.api.phpAggregator モジュールのプロセッサを作成する。
hook_aggregator_process_infomodules/aggregator/aggregator.api.php定義したプロセッサのタイトルと説明を指定する。
hook_aggregator_removemodules/aggregator/aggregator.api.php保存されているフィードデータが削除されたときにコードを実行する。
hook_ajax_render_altermodules/system/system.api.phpAjax フレームワークを通してユーザに送られるコマンドを変更する。
hook_archiver_infomodules/system/system.api.phpアーカイバーを宣言する。
hook_archiver_info_altermodules/system/system.api.php他のモジュールが定義したアーカイバーの情報を変更する。
hook_batch_altermodules/system/system.api.phpバッチが処理される前にそのバッチ情報を変更する。
hook_block_configuremodules/block/block.api.phpブロックの設定フォームを定義する。
hook_block_infomodules/block/block.api.phpモジュールが提供するブロックを定義する。
hook_block_info_altermodules/block/block.api.php他のモジュールが定義したブロックの定義をデータベースへの登録の前に変更する。
hook_block_list_altermodules/block/block.api.phpブロックリストが描画される前にコードを実行する。
hook_block_savemodules/block/block.api.phphook_block_configure() で定義された設定オプションが保存されたときの処理を実行する。
hook_block_viewmodules/block/block.api.phpブロックの描画済みのビュー、または描画可能なビューを返す。
hook_block_view_altermodules/block/block.api.phpブロックの内容に対して変更をかける。
hook_block_view_MODULE_DELTA_altermodules/block/block.api.php特定のブロックの内容に変更をかける。
hook_bootmodules/system/system.api.phpすべてのページリクエストに対してセットアップタスクを実行する。
hook_comment_deletemodules/comment/comment.api.phpモデレータがコメントを削除するときにコードを実行する。
hook_comment_insertmodules/comment/comment.api.phpコメントが挿入されるときにコードを実行する。
hook_comment_loadmodules/comment/comment.api.phpコメントがデータベースから読み込まれるときにコードを実行する。
hook_comment_presavemodules/comment/comment.api.phpコメントのバリデーションが通り、保存される前にコードを実行する。
hook_comment_publishmodules/comment/comment.api.phpモデレータがコメントを公開にするときにコードを実行する。
hook_comment_unpublishmodules/comment/comment.api.phpモデレータがコメントを非公開にするときにコードを実行する。
hook_comment_updatemodules/comment/comment.api.phpコメントが更新されるときにコードを実行する。
hook_comment_viewmodules/comment/comment.api.phpコメントが表示されるときにコードを実行する。このフックはテーマ化される前にコメントにデータを追加するために使うことができる。
hook_comment_view_altermodules/comment/comment.api.phpコメントが閲覧されたときにコードを実行する。構造化されたコンテンツを変更することができる。
hook_contextual_links_view_altermodules/contextual/contextual.api.php描画前にコンテクスチュアルリンク要素を変更する。
hook_countries_altermodules/system/system.api.phpデフォルトの国リストを変更する。
hook_cronmodules/system/system.api.php定期的なアクションを実行する。
hook_cron_queue_infomodules/system/system.api.php定期的に実行する必要のあるアイテムを持つキューを宣言する。
hook_cron_queue_info_altermodules/system/system.api.phpcron 処理が走る前に cron キューの情報を変更する。
hook_css_altermodules/system/system.api.phpCSS ファイルがページに出力される前に変更する。
hook_custom_thememodules/system/system.api.php現在のページで使うためのテーマのマシン名を返す。
hook_dashboard_regionsmodules/dashboard/dashboard.api.phpダッシュボードにリージョンを追加する。
hook_dashboard_regions_altermodules/dashboard/dashboard.api.php他のモジュールが提供するダッシュボードリージョンを変更する。
hook_date_formatsmodules/system/system.api.php追加の日付フォーマットを定義する。
hook_date_formats_altermodules/system/system.api.php他のモジュールが宣言した日付フォーマットを変更する。
hook_date_format_typesmodules/system/system.api.php追加の日付タイプを定義する。
hook_date_format_types_altermodules/system/system.api.php既存のデータタイプを変更する。
hook_deletemodules/node/node.api.phpノードの削除時にコードを実行する。
hook_disablemodules/system/system.api.phpモジュールが無効化される前に必要なアクションを実行する。
hook_drupal_goto_altermodules/system/system.api.phpdrupal_goto() でユーザが送られる先のページを変更する。
hook_element_infomodules/system/system.api.phpForm API 要素タイプを宣言しデフォルトの値を指定する。
hook_element_info_altermodules/system/system.api.php他のモジュールが返す要素タイプの情報を変更する。
hook_enablemodules/system/system.api.phpモジュールが有効化された後に必要なアクションを実行する。
hook_entity_deletemodules/system/system.api.phpエンティティが削除されるときにコードを実行する。
hook_entity_infomodules/system/system.api.phpエンティティタイプについてベースシステムとフィールド API に伝える。
hook_entity_info_altermodules/system/system.api.phpエンティティ情報を変更する。
hook_entity_insertmodules/system/system.api.phpエンティティが挿入されるときにコードを実行する。
hook_entity_loadmodules/system/system.api.phpエンティティが読み込まれるときにコードを実行する。
hook_entity_prepare_viewmodules/system/system.api.phpエンティティが表示用に準備されるときにコードを実行する。
hook_entity_presavemodules/system/system.api.phpエンティティが作成/更新される前にコードを実行する。
hook_entity_query_altermodules/system/system.api.phpEntityFieldQuery を変更/実行する。
hook_entity_updatemodules/system/system.api.phpエンティティが更新されるときにコードを実行する。
hook_entity_viewmodules/system/system.api.phpエンティティが描画の処理に入るところでコードを実行する。
hook_entity_view_altermodules/system/system.api.phpENTITY_view() の結果を変更する。
hook_entity_view_mode_altermodules/system/system.api.php表示されるエンティティの表示モードを変更する。
hook_exitmodules/system/system.api.phpクリーンアップタスクを実行する。
hook_field_accessmodules/field/field.api.phpユーザがフィールドにアクセスできるかどうかを決定する。
hook_field_attach_create_bundlemodules/field/field.api.phpfield_attach_create_bundle() のときにコードを実行する。
hook_field_attach_deletemodules/field/field.api.phpfield_attach_delete() のときにコードを実行する。
hook_field_attach_delete_bundlemodules/field/field.api.phpfield_attach_delete_bundle() のときにコードを実行する。
hook_field_attach_delete_revisionmodules/field/field.api.phpfield_attach_delete_revision() のときにコードを実行する。
hook_field_attach_formmodules/field/field.api.phpfield_attach_form() のときにコードを実行する。
hook_field_attach_insertmodules/field/field.api.phpfield_attach_insert() のときにコードを実行する。
hook_field_attach_loadmodules/field/field.api.phpfield_attach_load() のときにコードを実行する。
hook_field_attach_prepare_translation_altermodules/field/field.api.phpfield_attach_prepare_translation() に対して変更を加える。
hook_field_attach_preprocess_altermodules/field/field.api.phpfield_attach_preprocess() 変数に対して変更を加える。
hook_field_attach_presavemodules/field/field.api.phpfield_attach_presave() のときにコードを実行する。
hook_field_attach_purgemodules/field/field.api.phpfield_purge_data() のときにコードを実行する。
hook_field_attach_rename_bundlemodules/field/field.api.phpfield_attach_rename_bundle() のときにコードを実行する。
hook_field_attach_submitmodules/field/field.api.phpfield_attach_submit() のときにコードを実行する。
hook_field_attach_updatemodules/field/field.api.phpfield_attach_update() のときにコードを実行する。
hook_field_attach_validatemodules/field/field.api.phpfield_attach_validate() のときにコードを実行する。
hook_field_attach_view_altermodules/field/field.api.phpfield_attach_view() や field_view_field() に対して変更を加える。
hook_field_available_languages_altermodules/field/field.api.phpfield_available_languages() 変数を変更する。
hook_field_create_fieldmodules/field/field.api.phpフィールドが作成されるときにコードを実行する。
hook_field_create_instancemodules/field/field.api.phpフィールドインスタンスが作成されるときにコードを実行する。
hook_field_deletemodules/field/field.api.phpこのモジュールのフィールドデータに対してオリジナルの削除処理を定義する。
hook_field_delete_fieldmodules/field/field.api.phpフィールドが削除されるときにコードを実行する。
hook_field_delete_instancemodules/field/field.api.phpフィールドインスタンスが削除されるときにコードを実行する。
hook_field_delete_revisionmodules/field/field.api.phpこのモジュールのフィールドタイプに対してオリジナルのリビジョン削除処理を定義する。
hook_field_display_altermodules/field/field.api.phpフィールドの表示前にその表示設定を変更する。
hook_field_display_ENTITY_TYPE_altermodules/field/field.api.php特定のエンティティタイプのフィールドが表示される前にその表示設定を変更する。
hook_field_extra_fieldsmodules/field/field.api.php「擬似フィールド」コンポーネントをフィールド追加可能なエンティティに見せる。
hook_field_extra_fields_altermodules/field/field.api.phpフィールド追加可能なエンティティに対する「擬似フィールド」コンポーネントを変更する。
hook_field_extra_fields_display_altermodules/field/field.api.phpエンティティの表示前に擬似フィールドの表示設定を変更する。
hook_field_formatter_infomodules/field/field.api.phpフィールド API フォーマッタータイプを定義する。
hook_field_formatter_info_altermodules/field/field.api.phpフィールド API フォーマッタータイプに変更を加える。
hook_field_formatter_prepare_viewmodules/field/field.api.phpフィールドの値が表示されるときにフォーマッターに情報を読み込ませる。
hook_field_formatter_viewmodules/field/field.api.phpフィールドの値に対してレンダーアレイを構築する。
hook_field_infomodules/field/field.api.phpフィールド API フィールドタイプを定義する。
hook_field_info_altermodules/field/field.api.phpフィールド API フィールドタイプに変更を加える。
hook_field_info_max_weightmodules/field/field.api.phpモジュールが取り扱うエンティティコンポーネントの最大の重みを返す。
hook_field_insertmodules/field/field.api.phpこのモジュールのフィールドデータに対してオリジナルの挿入処理を定義する。
hook_field_is_emptymodules/field/field.api.phpフィールドタイプの空要素を定義する。
hook_field_language_altermodules/field/field.api.phpfield_language() の変数に変更を加える。
hook_field_loadmodules/field/field.api.phpこのモジュールのフィールドタイプのオリジナルの読み込み処理を定義する。
hook_field_prepare_translationmodules/field/field.api.phpこのモジュールのフィールドタイプのオリジナルの prepare_translation の処理を定義する。
hook_field_prepare_viewmodules/field/field.api.phpフィールドの表示用に値を準備する。
hook_field_presavemodules/field/field.api.phpこのモジュールのフィールドタイプにオリジナルの保存前の処理を定義する。
hook_field_purge_fieldmodules/field/field.api.phpフィールドレコードがパージされるときにコードを実行する。
hook_field_purge_instancemodules/field/field.api.phpフィールドインスタンスがパージされるときにコードを実行する。
hook_field_read_fieldmodules/field/field.api.phpフィールドがデータベースから読み込まれるときにコードを実行する。
hook_field_read_instancemodules/field/field.api.phpフィールドインスタンスが読み込まれるときにコードを実行する。
hook_field_schemamodules/field/field.api.phpフィールド構造のためのフィールド API スキーマを定義する。
hook_field_storage_create_fieldmodules/field/field.api.php新しいフィールドの作成時にコードを実行する。
hook_field_storage_deletemodules/field/field.api.phpエンティティのすべてのフィールドデータを削除する。
hook_field_storage_delete_fieldmodules/field/field.api.phpフィールド削除のときにコードを実行する。
hook_field_storage_delete_instancemodules/field/field.api.phpフィールドインスタンス削除のときにコードを実行する。
hook_field_storage_delete_revisionmodules/field/field.api.phpエンティティのフィールドデータの単一のリビジョンを削除する。
hook_field_storage_detailsmodules/field/field.api.phpフィールドのストレージの内部の詳細を示す。
hook_field_storage_details_altermodules/field/field.api.phpフィールド API ストレージの詳細に変更を加える。
hook_field_storage_infomodules/field/field.api.phpフィールド API ストレージのバックエンドを示す。
hook_field_storage_info_altermodules/field/field.api.phpフィールド API ストレージのタイプに変更を加える。
hook_field_storage_loadmodules/field/field.api.php一式のエンティティのフィールドデータを読み込む。
hook_field_storage_pre_insertmodules/field/field.api.phpストレージのバックエンドがフィールドデータを挿入するときにコードを実行する。
hook_field_storage_pre_loadmodules/field/field.api.phpストレージのバックエンドがフィールドデータを読み込むときにコードを実行する。
hook_field_storage_pre_updatemodules/field/field.api.phpストレージのバックエンドがフィールドデータを更新するときにコードを実行する。
hook_field_storage_purgemodules/field/field.api.phpフィールドデータがパージされるときにフィールドストレージの情報を削除する。
hook_field_storage_purge_fieldmodules/field/field.api.phpフィールドコードがパージされるときにフィールドストレージの情報を削除する。
hook_field_storage_purge_field_instancemodules/field/field.api.phpフィールドインスタンスがパージされるときにフィールドストレージの情報を削除する。
hook_field_storage_querymodules/field/field.api.phpEntityFieldQuery を実行する。
hook_field_storage_update_fieldmodules/field/field.api.phpフィールドのストレージ情報を更新する。
hook_field_updatemodules/field/field.api.phpこのモジュールのフィールドデータのオリジナルの更新処理を定義する。
hook_field_update_fieldmodules/field/field.api.phpフィールドが更新されるときにコードを実行する。
hook_field_update_forbidmodules/field/field.api.phpフィールドの更新が発生するのを禁止する。
hook_field_update_instancemodules/field/field.api.phpフィールドインスタンスが更新されるときにコードを実行する。
hook_field_validatemodules/field/field.api.phpこのモジュールのフィールドデータを検証する。
hook_field_widget_errormodules/field/field.api.phpフィールドレベルのバリデーションエラーのフラグを上げる。
hook_field_widget_formmodules/field/field.api.php単一のフィールドウィジェットのためのフォームを返す。
hook_field_widget_form_altermodules/field/field.api.php他のモジュールが提供するフィールドウィジェットフォームを変更する。
hook_field_widget_infomodules/field/field.api.phpフィールド API ウィジェットタイプを定義する。
hook_field_widget_info_altermodules/field/field.api.phpフィールド API ウィジェットタイプに変更を加える。
hook_field_widget_properties_altermodules/field/field.api.phpフィールドインスタンスのウィジェットプロパティの表示前に変更を加える。
hook_field_widget_properties_ENTITY_TYPE_altermodules/field/field.api.php特定のエンティティタイプのフィールドインスタンスのウィジェットプロパティの表示前に変更を加える。
hook_field_widget_WIDGET_TYPE_form_altermodules/field/field.api.php他のモジュールが提供する特定のウィジェットのウィジェットフォームを変更する。
hook_filetransfer_infomodules/system/system.api.phpモジュールが提供する FileTransfer クラスの情報を登録する。
hook_filetransfer_info_altermodules/system/system.api.phpFileTransfer クラスのレジストリを変更する。
hook_file_copymodules/system/system.api.phpファイルがコピーされたときにコードを実行する。
hook_file_deletemodules/system/system.api.phpファイルが削除されるときにコードを実行する。
hook_file_downloadmodules/system/system.api.phpプライベートファイルのダウンロードに対するアクセスを制御し HTTP ヘッダーを指定する。
hook_file_insertmodules/system/system.api.phpファイルが追加されるときにコードを実行する。
hook_file_loadmodules/system/system.api.phpファイルオブジェクトの追加の情報を読み込む。
hook_file_mimetype_mapping_altermodules/system/system.api.phpファイルの拡張子から MIME タイプを決定するのに使う MIME タイプマッピングを変更する。
hook_file_movemodules/system/system.api.phpファイルが削除されたときにコードを実行する。
hook_file_presavemodules/system/system.api.phpファイルが挿入/更新されるときにコードを実行する。
hook_file_updatemodules/system/system.api.phpファイルが更新されるときにコードを実行する。
hook_file_url_altermodules/system/system.api.phpファイルの URL を変更する。
hook_file_validatemodules/system/system.api.phpファイルが指定された基準を満たすのかチェックする。
hook_filter_format_disablemodules/filter/filter.api.phpテキストフォーマットが無効化されたときにコードを実行する。
hook_filter_format_insertmodules/filter/filter.api.php新しいテキストフォーマットが作成されたときにコードを実行する。
hook_filter_format_updatemodules/filter/filter.api.phpテキストフォーマットが更新されたときにコードを実行する。
hook_filter_infomodules/filter/filter.api.phpコンテンツフィルターを定義する。
hook_filter_info_altermodules/filter/filter.api.phpフィルターの定義に変更を加える。
hook_flush_cachesmodules/system/system.api.phpクリアするキャッシュテーブルのリストを追加する。
hook_formmodules/node/node.api.phpノード編集フォームを表示する。
hook_formsmodules/system/system.api.phpform_ids をビルダー関数にマップする。
hook_form_altermodules/system/system.api.phpフォームの描画前に変更を加える。
hook_form_BASE_FORM_ID_altermodules/system/system.api.php共有された(「ベース」)フォームのためにフォーム固有の変更を加える。
hook_form_FORM_ID_altermodules/system/system.api.phpグローバルな hook_form_alter() の代わりにフォーム固有の変更を加える。
hook_helpmodules/system/system.api.phpオンラインユーザヘルプを提供する。
hook_hook_infomodules/system/system.api.phpモジュールが定義するフックを定義する。
hook_hook_info_altermodules/system/system.api.phphook_hook_info() に変更を加える。
hook_html_head_altermodules/system/system.api.phpdrupal_get_html_head() が描画する前に XHTML HEAD タグを変更する。
hook_image_default_stylesmodules/image/image.api.phpDrupal 内で広く再利用するためにモジュールベースのイメージスタイルを提供する。
hook_image_effect_infomodules/image/image.api.phpモジュールが提供するイメージエフェクトの情報を定義する。
hook_image_effect_info_altermodules/image/image.api.phphook_image_effect_info() が提供する情報を経k脳する。
hook_image_styles_altermodules/image/image.api.php他のモジュールやユーザが提供したイメージスタイルに変更を加える。
hook_image_style_deletemodules/image/image.api.phpイメージスタイルの削除のときにコードを実行する。
hook_image_style_flushmodules/image/image.api.phpイメージスタイルのフラッシングのときにコードを実行する。
hook_image_style_savemodules/image/image.api.phpイメージスタイルの更新のときにコードを実行する。
hook_image_toolkitsmodules/system/system.api.phpこのモジュールが提供するイメージツールキットを定義する。
hook_initmodules/system/system.api.phpキャッシュされていないページリクエストに対してセットアップタスクを実行する。
hook_insertmodules/node/node.api.php新しいノードの作成のときにコードを実行する。
hook_installmodules/system/system.api.phpモジュールがインストールされるときにセットアップタスクを実行する。
hook_install_tasksmodules/system/system.api.phpインストールプロファイルが実行するタスクの配列を返す。
hook_install_tasks_altermodules/system/system.api.phpインストールタスクの完全なリストを変更する。
hook_js_altermodules/system/system.api.phpJavaScript がページに表示される前に必要な変更を加える。
hook_language_fallback_candidates_altermodules/system/language.api.php言語フォールバックの候補に変更を加える。
hook_language_initmodules/system/language.api.php言語の初期化が実行されたときにモジュールが何らかの処理を行えるようにする。
hook_language_negotiation_infomodules/system/language.api.php言語のネゴシエーションプロバイダを定義する。
hook_language_negotiation_info_altermodules/system/language.api.php言語のネゴシエーションプロバイダに変更を加える。
hook_language_switch_links_altermodules/system/language.api.php言語スイッチリンクに変更を加える。
hook_language_types_infomodules/system/language.api.php言語タイプを定義する。
hook_language_types_info_altermodules/system/language.api.php言語タイプに変更を加える。
hook_librarymodules/system/system.api.phpモジュールに関連づいた JavaScript/CSS ライブラリを登録する。
hook_library_altermodules/system/system.api.phpJavaScript/CSS ライブラリのレジストリを変更する。
hook_loadmodules/node/node.api.phpデータベースからノードが読み込まれたときにコードを実行する。
hook_localemodules/locale/locale.api.php翻訳可能なモジュールのテキストグループを定義する。
hook_mailmodules/system/system.api.phpパラメータに基いてメッセージを準備する。 drupal_mail() から呼び出される。
hook_mail_altermodules/system/system.api.phpdrupal_mail() 関数で作成されたメール・メッセージを変更する。
hook_menumodules/system/system.api.phpメニューアイテムとページコールバックを定義する。
hook_menu_altermodules/system/system.api.phphook_menu() の実行後 {menu_router} テーブルに保存されるデータを変更する。
hook_menu_breadcrumb_altermodules/system/system.api.phpアクティブトレイルのリンクがパンくずとして描画される前に変更する。
hook_menu_contextual_links_altermodules/system/system.api.phpコンテクスチュアルリンクを描画前に変更する。
hook_menu_deletemodules/menu/menu.api.phpカスタムメニューが削除されるときにコードを実行する。
hook_menu_get_item_altermodules/system/system.api.phpメニュールーターアイテムがデータベースやキャッシュから取得された直後に変更する。
hook_menu_insertmodules/menu/menu.api.phpカスタムメニューが作成されるときにコードを実行する。
hook_menu_link_altermodules/system/system.api.phpmenu_link_save() によって {menu_links} テーブルに保存されるデータを変更する。
hook_menu_link_deletemodules/system/system.api.phpメニューリンクが削除されたときにコードを実行する。
hook_menu_link_insertmodules/system/system.api.phpメニューリンクが作成されたときにコードを実行する。
hook_menu_link_updatemodules/system/system.api.phpメニューリンクが更新されたときにコードを実行する。
hook_menu_local_tasks_altermodules/system/system.api.phpページに表示されるタブとアクションがページに描画される前に変更する。
hook_menu_site_status_altermodules/system/system.api.phpメニューディスパッチの前にサイトステータスをコントロールする。
hook_menu_updatemodules/menu/menu.api.phpカスタムメニューが更新されるときにコードを実行する。
hook_modules_disabledmodules/system/system.api.phpモジュールが無効化された後に必要なアクションを実行する。
hook_modules_enabledmodules/system/system.api.phpモジュールが有効化された後に必要な処理を実行する。
hook_modules_installedmodules/system/system.api.phpモジュールがインストールされた後に必要な処理を実行する。
hook_modules_uninstalledmodules/system/system.api.phpモジュールがアンインストールされた後に必要な処理を実行する。
hook_module_implements_altermodules/system/system.api.phpフックを実装するモジュールのレジストリを変更する。
hook_multilingual_settings_changedmodules/locale/locale.api.php言語設定が変更されるときにコードを実行する。
hook_node_accessmodules/node/node.api.phpノードへのアクセスをコントロールする。
hook_node_access_recordsmodules/node/node.api.phpデータベースに書き込まれるノードの権限を設定する。
hook_node_access_records_altermodules/node/node.api.phpデータベースに書き込まれるノードの権限を変更する。
hook_node_deletemodules/node/node.api.phpノードが削除されるときにコードを実行する。
hook_node_grantsmodules/node/node.api.phpユーザがどんな権限を持つかという情報をノードアクセスシステムに知らせる。
hook_node_grants_altermodules/node/node.api.phpユーザがノードを閲覧/編集/削除しようとするときのユーザアクセスルールを変更する。
hook_node_infomodules/node/node.api.phpモジュールが提供するノードタイプを定義する。
hook_node_insertmodules/node/node.api.php新しいノードの作成の際にコードを実行する。
hook_node_loadmodules/node/node.api.php任意のノードがデータベースから読み込まれるときにコードを実行する。
hook_node_operationsmodules/node/node.api.phpマスのノードオペレーションを加える。
hook_node_preparemodules/node/node.api.php追加/編集フォームに表示される前のノードオブジェクトに処理を加える。
hook_node_presavemodules/node/node.api.php追加/更新されるノードに処理を加える。
hook_node_revision_deletemodules/node/node.api.phpノードリビジョンの削除のときにコードを実行する。
hook_node_search_resultmodules/node/node.api.phpノードが検索結果に表示されるときに処理を加える。
hook_node_submitmodules/node/node.api.php検証済のフォームの値がコピーされたノードに処理を加える。
hook_node_type_deletemodules/node/node.api.phpノードタイプ(コンテンツタイプ)が削除されたときに処理を実行する。
hook_node_type_insertmodules/node/node.api.phpノードタイプ(コンテンツタイプ)が作成されたときに処理を実行する。
hook_node_type_updatemodules/node/node.api.phpノードタイプ(コンテンツタイプ)が更新されたときに処理を実行する。
hook_node_updatemodules/node/node.api.phpノードが更新されたときに処理を実行する。
hook_node_update_indexmodules/node/node.api.phpノードが検索のためにインデックスされたときに処理を実行する。
hook_node_validatemodules/node/node.api.phpノードが作成/更新される前にノードのバリデーション処理を行う。
hook_node_viewmodules/node/node.api.phpノードが描画処理に入る前にコードを実行する。
hook_node_view_altermodules/node/node.api.phpnode_view() の結果を変更する。
hook_openidmodules/openid/openid.api.phpモジュールが OpenID リクエストパラメータを変更できる。
hook_openid_discovery_method_infomodules/openid/openid.api.phpモジュールが OpenID ディスカバリーメソッドを宣言できる。
hook_openid_discovery_method_info_altermodules/openid/openid.api.phpモジュールがディカバリーメソッドを変更できる。
hook_openid_normalization_method_infomodules/openid/openid.api.phpモジュールが OpenID ノーマライゼーションメソッドを宣言できる。
hook_openid_normalization_method_info_altermodules/openid/openid.api.phpモジュールがノーマライゼーションメソッドを変更できる。
hook_openid_responsemodules/openid/openid.api.phpOpenID のログイン成功時にモジュールが処理を実行できる。
hook_overlay_child_initializemodules/overlay/overlay.api.phpオーバーレイの子ウィンドウが初期化されるときにモジュールが処理を実行できる。
hook_overlay_parent_initializemodules/overlay/overlay.api.phpオーバーレイの親ウィンドウが初期化されるときにモジュールが処理を実行できる。
hook_page_altermodules/system/system.api.phpページが描画される前に変更を加える。
hook_page_buildmodules/system/system.api.phpページが描画される前にページに要素を加える。
hook_page_delivery_callback_altermodules/system/system.api.phpページコールバックの結果をブラウザに送信するために使うデリバリーコールバックを変更する。
hook_path_deletemodules/path/path.api.phpパスの削除時にコードを実行する。
hook_path_insertmodules/path/path.api.phpパスの挿入時にコードを実行する。
hook_path_updatemodules/path/path.api.phpパスの更新にコードを実行する。
hook_permissionmodules/system/system.api.phpユーザパーミッションを定義する。
hook_preparemodules/node/node.api.phpノードオブジェクトが追加/編集フォームで表示されるときにコードを実行する。
hook_query_altermodules/system/system.api.php構造化クエリに変更を加える。
hook_query_TAG_altermodules/system/system.api.php指定されたタグの構造化クエリに変更を加える。
hook_rankingmodules/node/node.api.phpコアのノード検索の結果のための追加のスコアリングメソッドを提供する。
hook_rdf_mappingmodules/rdf/rdf.api.phpモジュールがフィールドバンドルのための RDF マッピングを定義できる。
hook_rdf_namespacesmodules/rdf/rdf.api.phpモジュールが RDF マッピングの名前空間を定義できる。
hook_registry_files_altermodules/system/system.api.phpレジストリがパースしたファイルのリストにひつよな変更を加える。
hook_requirementsmodules/system/system.api.phpインストールの要件をチェックしステータスレポートを出す。
hook_schemamodules/system/system.api.phpデータベーススキーマの現在のバージョンを定義する。
hook_schema_altermodules/system/system.api.php既存のデータベーススキーマに変更を加える。
hook_search_accessmodules/search/search.api.phpオリジナルの検索ルーチンに対するアクセスを定義する。
hook_search_adminmodules/search/search.api.php検索設定フォームに要素を追加する。
hook_search_executemodules/search/search.api.phpキーワードのセットに対して検索を実行する。
hook_search_infomodules/search/search.api.phpオリジナルの検索タイプを定義する。
hook_search_pagemodules/search/search.api.php検索結果の描画を上書きする。
hook_search_preprocessmodules/search/search.api.php検索テキストの前処理を行う。
hook_search_resetmodules/search/search.api.php検索インデックスが再構築される前にコードを実行する。
hook_search_statusmodules/search/search.api.phpインデクシングのステータスをレポートする。
hook_shortcut_default_setmodules/shortcut/shortcut.api.php提供されたユーザアカウントに対するデフォルトのショートカットの名前を返す。
hook_simpletest_altermodules/simpletest/simpletest.api.phpテストのリストを変更する。
hook_stream_wrappersmodules/system/system.api.phpモジュールに関連づけられた PHP ストリームラッパーの実装を登録する。
hook_stream_wrappers_altermodules/system/system.api.phpPHP ストリームラッパーの実装のリストに変更を加える。
hook_system_info_altermodules/system/system.api.phpモジュールとテーマの .info ファイルからパースされた情報に変更を加える。
hook_system_themes_page_altermodules/system/system.api.phptheme のオペレーションリンクを変更する。
hook_system_theme_infomodules/system/system.api.phpモジュールが提供する追加の theme を返す。
hook_taxonomy_term_deletemodules/taxonomy/taxonomy.api.phpタクソノミータームが削除されたときに処理を実行する。
hook_taxonomy_term_insertmodules/taxonomy/taxonomy.api.phpタクソノミータームが作成されたときに処理を実行する。
hook_taxonomy_term_loadmodules/taxonomy/taxonomy.api.phpタクソノミータームが読み込まれたときに処理を実行する。
hook_taxonomy_term_presavemodules/taxonomy/taxonomy.api.phpタクソノミータームが保存される前に処理を実行する。
hook_taxonomy_term_updatemodules/taxonomy/taxonomy.api.phpタクソノミータームが更新されたときに処理を実行する。
hook_taxonomy_term_viewmodules/taxonomy/taxonomy.api.phpタクソノミータームが描画用に用意されたときに処理を実行する。
hook_taxonomy_term_view_altermodules/taxonomy/taxonomy.api.phptaxonomy_term_view() の結果を変更する。
hook_taxonomy_vocabulary_deletemodules/taxonomy/taxonomy.api.phpタクソノミーボキャブラリーの削除のときにコードを実行する。
hook_taxonomy_vocabulary_insertmodules/taxonomy/taxonomy.api.phpタクソノミーボキャブラリーが挿入されるときにコードを実行する。
hook_taxonomy_vocabulary_loadmodules/taxonomy/taxonomy.api.phpタクソノミーボキャブラリーが読み込まれるときにコードを実行する。
hook_taxonomy_vocabulary_presavemodules/taxonomy/taxonomy.api.phpタクソノミーボキャブラリーが保存される前にコードを実行する。
hook_taxonomy_vocabulary_updatemodules/taxonomy/taxonomy.api.phpタクソノミーボキャブラリーが更新されるときにコードを実行する。
hook_test_finishedmodules/simpletest/simpletest.api.php個別のテストの実行が完了したときに処理を実行する。
hook_test_group_finishedmodules/simpletest/simpletest.api.phpテストグループの実行が完了したときに処理を実行する。
hook_test_group_startedmodules/simpletest/simpletest.api.phpテストグループの実行が開始したときに処理を時刻する。
hook_thememodules/system/system.api.phpモジュールやテーマの theme (英語だとシーム)実装を登録する。
hook_theme_registry_altermodules/system/system.api.phphook_theme() が返すテーマレジストリ情報を変更する。
hook_tokensmodules/system/system.api.phpプレースホルダートークンの代替値を提供する。
hook_tokens_altermodules/system/system.api.phpプレースホルダートークンの代替値を変更する。
hook_token_infomodules/system/system.api.php利用可能なプレースホルダートークンとトークンタイプの情報を提供する。
hook_token_info_altermodules/system/system.api.php利用可能なプレースホルダートークンとトークンタイプのメタデータを変更する。
hook_translated_menu_link_altermodules/system/system.api.phpメニューリンクの翻訳後・描画前にメニューリンクを変更する。
hook_trigger_infomodules/trigger/trigger.api.phpユーザがアクションを割り当てられるトリガー(イベント)を宣言する。
hook_trigger_info_altermodules/trigger/trigger.api.phphook_trigger_info() が宣言したトリガーを変更する。
hook_uninstallmodules/system/system.api.phpモジュールがセットした情報を削除する。
hook_updatemodules/node/node.api.phpノードが更新されたときに処理を実行する。
hook_updater_infomodules/system/system.api.phpアップデーター( Drupal を更新できるクラス)の情報を提供する。
hook_updater_info_altermodules/system/system.api.phpアップデーター情報の配列を変爻する。
hook_update_dependenciesmodules/system/system.api.phpモジュール更新依存関係の情報を格納した配列を返す。
hook_update_indexmodules/search/search.api.phpこのモジュールの検索インデックスを更新する。
hook_update_last_removedmodules/system/system.api.phphook_update_N() としてすでに利用不可となった番号を返す。
hook_update_Nmodules/system/system.api.phpモジュールのアップデート時の処理を記述する。
hook_update_projects_altermodules/update/update.api.phpプロジェクトのリストをデータの取得とバージョンの比較を行う前に変更する。
hook_update_status_altermodules/update/update.api.phpプロジェクトの利用可能な更新についての情報を変更する。
hook_url_inbound_altermodules/system/system.api.phpインバウンド URL リクエストを変更する。
hook_url_outbound_altermodules/system/system.api.phpアウトバウンド URL を変更する。
hook_username_altermodules/system/system.api.phpユーザに表示されるユーザ名を変更する。
hook_user_cancelmodules/user/user.api.phpユーザアカウントがキャンセルされるときに処理を実行する。
hook_user_cancel_methods_altermodules/user/user.api.phpユーザアカウントキャンセルメソッドを変更する。
hook_user_categoriesmodules/user/user.api.phpユーザ設定やプロフィール情報カテゴリのリストを取得する。
hook_user_deletemodules/user/user.api.phpユーザアカウントが削除されたときに処理を実行する。
hook_user_insertmodules/user/user.api.phpユーザアカウントが作成されたときに処理を実行する。
hook_user_loadmodules/user/user.api.phpユーザオブジェクトがデータベースから読み込まれたときに処理を実行する。
hook_user_loginmodules/user/user.api.phpユーザがログインしたときに処理を実行する。
hook_user_logoutmodules/user/user.api.phpユーザがログアウトしたときに処理を実行する。
hook_user_operationsmodules/user/user.api.phpマスのユーザオペレーションを追加する。
hook_user_presavemodules/user/user.api.phpユーザアカウントが作成/更新される前に処理を実行する。
hook_user_role_deletemodules/user/user.api.phpユーザの役割が削除されたときに処理を実行する。
hook_user_role_insertmodules/user/user.api.phpユーザの役割が作成されたときに処理を実行する。
hook_user_role_presavemodules/user/user.api.phpユーザの役割が作成/更新される前に処理を実行する。
hook_user_role_updatemodules/user/user.api.phpユーザの役割が更新されたときに処理を実行する。
hook_user_updatemodules/user/user.api.phpユーザアカウントが更新されたときに処理を実行する。
hook_user_viewmodules/user/user.api.phpユーザのアカウント情報が表示される前に処理を実行する。
hook_user_view_altermodules/user/user.api.phpユーザのアカウント情報が表示される前に構造化されたコンテンツを変更する。
hook_validatemodules/node/node.api.phpノードの作成/更新前にノードバリデーションを実行する。
hook_verify_update_archivemodules/update/update.api.phpアーカイブがダウンロードされ展開された後に変更を加える。
hook_viewmodules/node/node.api.phpノードを表示する。
hook_watchdogmodules/system/system.api.phpイベントメッセージをログに記録する。
hook_xmlrpcmodules/system/system.api.phpXML-RPC コールバックを定義する。
hook_xmlrpc_altermodules/system/system.api.phpXML-RPC メソッドが呼ばれる前にその定義を変更する。
module_hookincludes/module.incモジュールがフックを実装しているかどうかを調べる。
module_hook_infoincludes/module.inchook_hook_info() で宣言されているフックのリストを取得する。
module_implementsincludes/module.incフックを実装しているモジュールを返す。
module_implements_write_cacheincludes/module.incフック実装のキャッシュを書き込む。
module_invokeincludes/module.inc特定のモジュールの特定のフックを実行する。
module_invoke_allincludes/module.incすべての有効化されたモジュールの特定のフックを実行する。

以上です。 いかがだったでしょうか?

なるべくわかりやすい翻訳を心がけていますが、わかりづらいところや改善できるところを発見されたらお気軽にご連絡いただけますと幸いです。

この記事は役に立ちましたか?

スタジオ・ウミは約20年の実績を誇るDrupal専門の開発会社です。豊富な知見とノウハウでDrupalサイトの開発や技術サポートなどDrupal関連サービスをワンストップでご提供します。

RECRUIT

新たな​ステージを​共に​歩んでいける​コアメンバーを​募集しています

採用情報

CONTACT

お仕事の​ご相談や​お見積依頼など、​お気軽に​お問い​合わせください。

お問い合わせ