module_invoke_all('some_hook')
の使用は簡単ですが、これはパフォーマンスの点で優れていますか?
foreach (module_implements('some_hook') as $module) {
$data = module_invoke($module, 'some_hook');
}
違いはほとんどありません。 module_invoke_all()
は次のコードを実行します。
function module_invoke_all() {
$args = func_get_args();
$hook = $args[0];
unset($args[0]);
$return = array();
foreach (module_implements($hook) as $module) {
$function = $module . '_' . $hook;
if (function_exists($function)) {
$result = call_user_func_array($function, $args);
if (isset($result) && is_array($result)) {
$return = array_merge_recursive($return, $result);
}
elseif (isset($result)) {
$return[] = $result;
}
}
}
return $return;
}
唯一の違いは、module_invoke_all()
を使用すると、たとえば、func_get_args()
が1回だけ呼び出されるのに対し、module_invoke()
を使用すると、func_get_args()
が毎回呼び出されるという点ですmodule_invoke()
が呼び出されます。ただし、それはわずかな違いです。module_implementing()
とmodule_invoke()
が使用されるいくつかのケースがあります。通常、search_get_info()
検索機能を実装するモジュールに関する情報の配列を作成します。
function search_get_info($all = FALSE) {
$search_hooks = &drupal_static(__FUNCTION__);
if (!isset($search_hooks)) {
foreach (module_implements('search_info') as $module) {
$search_hooks[$module] = call_user_func($module . '_search_info');
// Use module name as the default value.
$search_hooks[$module] += array(
'title' => $module,
'path' => $module,
);
// Include the module name itself in the array.
$search_hooks[$module]['module'] = $module;
}
}
if ($all) {
return $search_hooks;
}
$active = variable_get('search_active_modules', array('node', 'user'));
return array_intersect_key($search_hooks, array_flip($active));
}
別の例は image_styles() で、モジュールによって実装されたすべての画像スタイルのリストを取得し、次のコードを使用します。
foreach (module_implements('image_default_styles') as $module) {
$module_styles = module_invoke($module, 'image_default_styles');
foreach ($module_styles as $style_name => $style) {
$style['name'] = $style_name;
$style['module'] = $module;
$style['storage'] = IMAGE_STORAGE_DEFAULT;
foreach ($style['effects'] as $key => $effect) {
$definition = image_effect_definition_load($effect['name']);
$effect = array_merge($definition, $effect);
$style['effects'][$key] = $effect;
}
$styles[$style_name] = $style;
}
}
どちらの場合も、取得された情報は、インデックスがモジュールの短い名前である配列に入れられます。
コードを見ると、 module_invoke_all がそれと、いくつかの健全性チェックを行います。そして、それは簡単です。 :-)