hook_field_formatter_settings_form() and hook_field_formatter_settings_summary() should be in the field_formatter group

Created on 30 June 2016, about 8 years ago
Updated 1 July 2016, about 8 years ago

Problem/Motivation

The functions hook_field_formatter_settings_form() and hook_field_formatter_settings_summary() are closely related to the Field Formatter API, but are not in that group.

Note these functions have no corresponding _alter() functions.

I ran into this while looking at hook_field_formatter_info() on api.drupal.org. It's documentation says that the return value should be an array that can contain a "settings" sub-array whose keys are the names of the settings available for the formatter type, and whose values are the default values for those settings; but I could not find the functions to set the settings in either of the Related topics for that function.

Proposed resolution

Add @ingroup field_formatter to the docblocks of both these functions.

According to the documentation standards, @ingroup is used to selectively add items to existing groups.

Note that hook_field_formatter_settings_form() and hook_field_formatter_settings_summary() are already part of the Field Types API (field_types) group; however, there are many instances of functions belonging to more than one group (e.g.: callback_search_conditions()).

Remaining tasks

  1. Review
  2. RTBC
  3. Commit and update api.drupal.org

User interface changes

None.

API changes

None.

Data model changes

None.

Feature request
Status

Needs review

Version

7.0 ⚰️

Component
Documentation 

Last updated less than a minute ago

No maintainer
Created by

🇨🇦Canada mparker17 UTC-4

Live updates comments and jobs are added and updated live.
  • Novice

    It would make a good project for someone who is new to the Drupal contribution process. It's preferred over Newbie.

Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Production build 0.71.5 2024