如何为自己的模板使用主题预处理器功能?

jer*_*son 36 preprocessor drupal drupal-6 drupal-theming

我有几个节点,CCK字段和视图主题的.tpl.php文件.这些模板文件中有很多逻辑可以移动,剥离链接,创建新链接等等.我知道这是糟糕的开发而不是"Drupal Way".

如果我理解正确,"Drupal Way"是在template.php文件中使用预处理器函数来操作变量并添加新变量.关于这个问题:

  • 是否有为特定主题创建预处理器函数的命名约定?例如,如果我调用了CCK字段模板content-field-field_transmission_make_model.tpl,我该如何命名预处理器函数?
  • 我可以将模板预处理器函数用于节点模板,CCK字段模板和视图模板吗?他们有不同的修改模板变量或添加新变量的方法吗?

Hen*_*pel 56

总体而言,您应该阅读在预处理函数中操作变量.


关于命名约定,这通常很简单,但是你的当前示例有一个问题(见下文):

需要预处理函数签名

[yourModuleName|yourThemeName]_preprocess_[themeFunctionName](&$variables)

因此,在主题template.php文件中为页面模板实现一个将导致

themeName_preprocess_page(&$variables)

大多数情况下,主题函数的名称将是*.tpl.php文件的名称,没有.tpl.php结尾和下划线而不是连字符.但是,如果在模板建议的基础上选择模板文件,则会有一个问题,因为预处理功能只能用于基本名称,而不能用于其他建议!(备用模板文件的建议在预处理函数本身中添加.)

您当前的示例就是其中一种情况,就像content-field-field_transmission_make_model.tpl.php这样的建议一样,基本名称是content-field.tpl.php,并且相应的主题函数是content_field.因此,您必须实现一个名为的预处理函数yourThemeName_preprocess_content_field(&$variables),并在其中检查$ variables数组中的可用条目,以检查您是否实际调用了'field_transmission_make_model',而不是完全不同的CCK字段,例如:

function yourThemeName_preprocess_content_field(&$variables) {
  // Are we called for the right field?
  if ('field_transmission_make_model' == $variables['field_name']) {
    // Yes, add/manipulate entries within the variables array
    $variables['new_entry'] = 'A useless new variable';
    $variables['label'] = 'A useless change of the existing label variable';
  }
}
Run Code Online (Sandbox Code Playgroud)

(注意:未经测试的代码,谨防拼写错误)

在此之后,$new_entry模板文件中应该有一个新变量,并且$label变量的内容应该已经更改($ variables数组中的所有顶级条目将变为模板文件的单独变量,以数组命名指数).


至于你的第二个问题,预处理函数的基本用法对于所有模板文件都是相同的,但要注意:

  • 预处理函数仅适用于使用*.tpl.php文件的主题调用,而不适用于主题函数
  • $ variables数组的内容差别很大,具体取决于获得主题的内容
  • 其他模块也可以实现预处理函数,并且它们将被一个接一个地调用,所以如果你想要改变由另一个模块添加的东西,你只能在那之后调用你的实现(这将是no)在你的情况下的问题,因为在模块中的所有实现之后调用主题中的实现 - 只是想提到可以同时有许多实现)

  • @Jergason:虽然肯定会有一点开销,但函数调用本身几乎没有任何成本,只要它不进行大量处理(你需要数十万次调用才能在几毫秒内测量它).根据我的经验,保持模板文件清理"高级"处理逻辑的优势是值得的(特别是如果有一天你想要/需要分割工作量并将它们传递给设计师). (3认同)