Document that field tokens need proper display modes setup

Problem/Motivation

Text field tokens appear in the token browser list when the type "node" is selected, but then during token_replace(), they are not generated by token_tokens() or field_tokens().

Example: I have a text field called "photo credit", and it appears in the token list as [node:field_photo_credit]. But when I use this token, it is not getting a value in token_replace().

Proposed resolution

Fix field_tokens() so that it generates field token replacements for nodes and other entities. I think the problem is here (about 3 lines down in the function):

  if ($type == 'entity' && !empty($data['entity_type']) && !empty($data['entity']) && !empty($data['token_type'])) {

This is only generating replacements for $type == 'entity', but if the token name is "node:" then $type == 'node'.

Remaining tasks

See summary.

User interface changes

None.

API changes

None.

Original report by jhodgdon

I'm running into kind of an odd problem that I just spent about an hour attempting to debug, and still failed.... This is for a site that someone else set up and I inherited. Here's the situation (Drupal 7.x, Colorbox 7.x-1.4, Token 7.x-1.4)

- We have a content type "Bird", with a nodereference field "Related Images", which contains one or more nodes of content type "Photo".
- Content type Photo has an Image field on it (field_image) and a Text field (field_photo_credit).
- There is a View that is displayed as a block on Bird pages, which is using colorbox to display the related images. It has a relationship to the Photos (via the nodereference field), and then field_image is chosen as a Field in the View.
- The formatter for the field is set to "Colorbox", and we want to display a custom caption that says "(photo node title) by (photo credit)".

So here's the problem -- there are two:

a) In the Views field formatter settings, when I choose a "custom" caption, the token replacements listed for the custom caption do not list any node-related tokens (only site-generic and File tokens are listed). In debugging, I found out that Colorbox thinks for some reason that it should get a list of all "ctools" and "file" tokens, and since that is what it is telling the Token module, node tokens are not being added to the list. I don't know why that would be... As a note, if I try to set up the Image field on the Photo content type to display with a custom caption, on that token list I get the node tokens -- so it's only within Views that I don't. I have no idea why.

b) From the token list on the Photo content type, I did find the correct token names. So I set up the custom field as "[node:title] by [node:field_photo_credit]", but it doesn't work -- the photo credit spot always comes up blank. I tried debugging this, but I couldn't figure out why this token replacement was not working... It also didn't work when I did this directly on the Photo content type's "Manage Display" screen, using the token selector (which had both of these as options), so it is the same result inside and outside Views.

So is there a way for me to get this to work? I'm not sure if the problem lies in Colorbox, or Token, or in how they are interacting.... Any ideas or help would be much appreciated!!