Allowed values functions are undocumented

Created on 25 April 2012, over 13 years ago
Updated 9 September 2025, 29 days ago

In #1541792: Enable dynamic allowed list values function with additional context β†’ we are changing the arguments passed to an allowed values function, and I realized there isn't any documentation for them.

list_test_allowed_values_callback() is the only example in core, and its docblock just says "Allowed values callback."

This is part of the Field API, but only applies to List field types that have allowed values.

One possibility is to document any custom settings in hook_field_info. This might be superseded by the OO Field API.

πŸ“Œ Task
Status

Postponed: needs info

Version

11.0 πŸ”₯

Component

field system

Created by

πŸ‡ΊπŸ‡ΈUnited States tim.plunkett Philadelphia

Live updates comments and jobs are added and updated live.
  • Needs backport to D7

    After being applied to the 8.x branch, it should be considered for backport to the 7.x branch. Note: This tag should generally remain even after the backport has been written, approved, and committed.

  • stale-issue-cleanup

    To track issues in the developing policy for closing stale issues, [Policy, no patch] closing older issues

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.

  • πŸ‡ΊπŸ‡ΈUnited States smustgrave

    Thank you for creating this issue to improve Drupal.

    We are working to decide if this task is still relevant to a currently supported version of Drupal. There hasn't been any discussion here for over 8 years which suggests that this has either been implemented or is no longer relevant. Your thoughts on this will allow a decision to be made.

    Since we need more information to move forward with this issue, the status is now Postponed (maintainer needs more info). If we don't receive additional information to help with the issue, it may be closed after three months.

    Thanks!

  • πŸ‡¬πŸ‡§United Kingdom joachim

    There is callback_allowed_values_function() in api docs, and various methods are marked as this.

    If any are missing this, it's a specific docs issue rather than this global one, which I think we can say is done.

  • Now that this issue is closed, please review the contribution record.

    As a contributor, attribute any organization helped you, or if you volunteered your own time.

    Maintainers, please credit people who helped resolve this issue.

Production build 0.71.5 2024