field_bundle_settings() doc example is wrong [#1055234]

To set or get the 'visibility' of an 'extra' field using field_bundle_settings(),
the example in code says this:

      'extra_field_1' => array(
        // One sub-array per view mode for the entity type, including
        // the 'default' mode:
        'default' => array(
          'weight' => The weight of the pseudo-field,
          'visibility' => Whether the pseudo-field is visible or hidden,
        ),
        'full' => ...
      ),

But the code in field_ui_display_overview_form_submit() says this:

  // Save data for 'extra' fields.
  foreach ($form['#extra'] as $name) {
    $bundle_settings['extra_fields']['display'][$name][$view_mode] = array(
      'weight' => $form_values['fields'][$name]['weight'],
      'visible' => $form_values['fields'][$name]['type'] == 'visible',
    );
  }

The difference
is that 'visibility' is controlled by:
$view_mode['visible'] = TRUE; // or FALSE
and NOT by
$view_mode['visibility'] = 'visible';// looks like values are 'visible' or 'hidden'

Comment	File	Size	Author
#11	1055234-11-field-bundle-visibility.patch	1.21 KB	linclark
#11
#5	1055234-v2.patch	2.18 KB	jhodgdon
#5
#4	1055234.patch	2.18 KB	jhodgdon
#4

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

manimejia CreditAttribution: manimejia commented 8 February 2011 at 20:12

Title:

Documentation problem with Reply to comment

» Documentation problem with field_bundle_settings()

Comment #2

jhodgdon

she/her

English

CreditAttribution: jhodgdon commented 9 February 2011 at 22:43

Title:

Documentation problem with field_bundle_settings()

» field_bundle_settings() doc example is wrong

That assessment looks correct to me, but we should also check the code that uses the bundle settings and verify there.

Comment #3

jhodgdon

she/her

English

CreditAttribution: jhodgdon commented 10 February 2011 at 22:53

I grepped through the code, and am seeing 'visibility' being used in:
- hook_field_extra_fields_display_alter() -- sample function body
- field_info_extra_fields() docblock example (similar to the one in this issue)

Ah. _field_extra_fields_pre_render(), which actually uses the visibility information referenced here, is definitely looking for a ['visible'] component as a boolean. And I found this usage in other spots too... So I can confirm the analysis in this issue report. The 2 above spots also need to be fixed along with the spot reported in this issue.

Comment #4

jhodgdon

she/her

English

CreditAttribution: jhodgdon commented 10 February 2011 at 23:03

Status:

Active

» Needs review

File	Size
1055234.patch	2.18 KB

Here's a patch.

Comment #5

jhodgdon

she/her

English

CreditAttribution: jhodgdon commented 10 February 2011 at 23:04

File	Size
1055234-v2.patch	2.18 KB

It might help if I could spell visible. Try this patch instead.

Comment #6

kim-day CreditAttribution: kim-day commented 15 March 2011 at 02:21

The patch looks good to me. It fixes the 3 instances correctly.

Comment #7

jhodgdon

she/her

English

CreditAttribution: jhodgdon commented 15 March 2011 at 17:59

Version:	7.x-dev	» 8.x-dev
Status:	Needs review	» Reviewed & tested by the community

RTBC as per #6. Should be applied to 8.x and 7.x.

Comment #8

Dries CreditAttribution: Dries commented 23 April 2011 at 23:07

Status:

Reviewed & tested by the community

» Needs work

Patch no longer applies to 8.x or 7.x. Needs a re-roll.

Comment #9

Dries CreditAttribution: Dries commented 23 April 2011 at 23:07

Status:

Needs work

» Needs review

#5: 1055234-v2.patch queued for re-testing.

Comment #10

23 April 2011 at 23:42

Status:

Needs review

» Needs work

The last submitted patch, 1055234-v2.patch, failed testing.

Comment #11

Anonymous (not verified) CreditAttribution: Anonymous commented 27 April 2011 at 20:43

Status:

Needs work

» Needs review

File	Size
1055234-11-field-bundle-visibility.patch	1.21 KB

I rerolled the patch. It looks like the last instance, in field.api.php, must have been caught in another patch. Comment #3 has the summary.

Comment #12

jhodgdon

she/her

English

CreditAttribution: jhodgdon commented 27 April 2011 at 21:02

Status:

Needs review

» Reviewed & tested by the community

Thanks linclark! Assuming the test bot agrees and the patch applies, this should be back to RTBC. Confirmed that the third hunk from the previous patch is already at
http://api.drupal.org/api/drupal/modules--field--field.api.php/function/...