Paragraph-Item Bundle-specifc templates are never called.

[jenlampton]

I'm having a problem perhapx similar to #194, but in my case I cannot get an override for paragraphs-item.tpl.php to work at all.

I have a bundle named section and I can see this in by printing it out in my preprocess hook, as follows:

/**
 * Prepare variables for paragraph-item templates.
 */
function hook_preprocess_paragraphs_item(&$variables) {
  dpm($variables['paragraphs_item']->bundle);
}

But when I create a template file named paragraphs-item--section.tpl.php it is never called.

When I enable theme debug and look at the suggestions for overrides, I see the following:

 FILE NAME SUGGESTIONS:
   x paragraphs-item.tpl.php
   * paragraphs-item--section.tpl.php
   * paragraphs-item--section--paragraphs-editor-preview.tpl.php
   * paragraphs-item--5.tpl.php
   x paragraphs-item.tpl.php

I wonder if the problem is that paragraphs-item.tpl.php appears in here twice, at both ends. This would make that file "win" the selection process, regardless of which way the suggestions are checked.

In my preprocessor, I needed to remove the duplicate suggestion, as follows:

function hook_preprocess_paragraphs_item(&$variables) {
  // Clean up theme hook suggstions.
  $names = array();
  foreach ($variables['theme_hook_suggestions'] as $key => $name) {
    if (!in_array($name, $names)) {
      $names[$key] = $name;
    }
    else {
      unset($variables['theme_hook_suggestions'][$key]);
    }
  }
  unset($variables['theme_hook_suggestion']);
}

I couldn't find where this extra suggestion is being added in paragraphs. Perhaps this is an entity_plus issue?

[olafgrabienski]

I wonder if the problem is that paragraphs-item.tpl.php appears in here twice, at both ends.

@jenlampton The duplicate theme suggestion reminds me a similar issue I've noticed just yesterday: one of the classes in the paragrahps output is rendered twice. See paragraphs-item-image in the example below:

<!-- BEGIN OUTPUT from 'modules/paragraphs/theme/paragraphs-item.tpl.php' -->
<div id="paragraphs-item-3" class="paragraphs-item paragraphs-item-image paragraphs-item-image paragraphs-item-full paragraphs-item-3">

update: There is now a separate issue re the duplicated css class, see #258.

[laryn]

This is definitely worth investigating further. At one point I vaguely recall that it was necessary to have a vanilla copy of paragraphs-item.tpl.php in your own theme's template directory in order for it to pick up the customized version(s), but I don't recall why, or if that was fixed.

[argiepiano]

This issue may be related to one that was fixed some time ago for core entities. See my comment here.

Looking at ParagraphsItemEntityController.inc I see that ParagraphsItemEntityController::buildContent() actually also hardcodes the template in '#theme' =>, similar to the issue I referred above. Perhaps the solution implemented in that issue will work here?

EDIT: Hmmm... I'm not sure of this anymore. Paragraphs actually uses #theme correctly here, referencing the entity type name. I'll try to dig into this when I have time.

[argiepiano]

I'm trying to reproduce this problem. I do see paragraphs-item.tpl.php twice, but in my case both are at the bottom, and the overridden version (which I put in Basis in my test) is working fine - it's picking up paragraphs-item--test.tpl.php, which is my override in Basis. @jenlampton wondering if you have a preprocess override or module that is altering the order?

I do agree that it's strange to see paragraphs-item.tpl.php twice, but in my test this is not causing issues. I'll try to see if I can figure out where this duplication is coming from.

[argiepiano]

OK, I've traced the origin of the duplicate paragraphs-item.tpl.php suggestion. In template_preprocess_paragraphs_item(), Paragraphs should not do $variables['theme_hook_suggestions'][] = $paragraphs_item_type;. This base hook is always added by core at the lowest priority.

But, @jenlampton, you are dealing with a second problem. Core is adding that base hook at the highest priority. My guess is that you are somehow altering the order of the calls for the preprocess hooks, and core ends up being called first.

So the fix I'm proposing here will NOT fix your issue. Your problem is that paragraphs-item.tpl.php is first in that list you pasted. The duplication of that is not the issue here.

[argiepiano]

I'm going to open a separate issue about the duplicate listing of paragraphs-item.tpl.php, to avoid confusing the source of the problem in this issue.

[argiepiano]

Split this into #249 with PR #250

[laryn]

I merged the fix for #249 -- does that change anything for you @jenlampton?

[markabur]

I've been troubleshooting this issue off and on for over a year. I am still seeing it in 1.3.8.

Pretty quickly I found a way to fix it in my custom theme:

function mytheme_preprocess_paragraphs_item(&$vars) {
  unset($vars['theme_hook_suggestion']);
}

But it has always bugged me that that's necessary, because it wasn't needed in Drupal 7.

Here is where theme_hook_suggestion gets set, in theme():

  if (isset($info['base hook'])) {
    $base_hook = $info['base hook'];
    $base_hook_info = isset($hooks[$base_hook]) ? $hooks[$base_hook] : array();
    $base_hook_info += array(
      'includes' => array(),
      'preprocess functions' => array(),
    );
    // Include files required by the base hook, since its variable preprocessors
    // might reside there.
    foreach ($base_hook_info['includes'] as $include_file) {
      include_once BACKDROP_ROOT . '/' . $include_file;
    }
    $variables['theme_hook_suggestion'] = $hook;
    $hook = $base_hook;

    // Combine preprocess functions to call the base hook and child functions.
    $info['preprocess functions'] = array_unique(array_merge($base_hook_info['preprocess functions'], $info['preprocess functions']));
  }

When the paragraph item is rendered, theme() is called with paragraphs_item as the hook. The info for paragraphs_item has base_hook set to entity_plus, so theme_hook_suggestion is set to paragraphs_item, which prevents template overrides.

However, in Drupal when the paragraph_item is rendered, theme() is called with entity as the hook. The info for entity has no base_hook, so theme_hook_suggestion is never set, and template overrides work as expected.

For the longest time I couldn't figure out why there was a difference between Drupal and Backdrop. I suspected entity_plus, but I don't know anything about it. I thought that somehow base hook was being set when it wasn't supposed to be, but I couldn't find anyplace that did that.

Finally today I realized that the theme() hook comes from the element's #theme, and found that this change in ParagraphsItemEntityController fixes the template override problem:

//    $build['#theme'] = 'paragraphs_item';

With this change, theme() gets called with entity_plus as the hook, and just like entity in Drupal, it has no base hook, so theme_hook_suggestion is not set.

It does appear to cause some new test exceptions which I haven't looked into.

[markabur]

Ok, forget about changing ParagraphsItemEntityController like that as it causes other problems.

@jenlampton here is something to try instead of unset($variables['theme_hook_suggestion']);

function mytheme_theme_registry_alter(&$theme_registry) {
  unset($theme_registry['paragraphs_item']['base hook']);
}