Drupal
/
drupal
mirror of https://git.drupalcode.org/project/drupal.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Issue #2146045 by D Szkiba, joshi.rohit100, tyler.frankenstein, er.pushpinderrana, dajjen, jhodgdon, joachim: Document Field API allowed_values_function callback

8.0.x
xjm 2015-04-19 14:41:47 +02:00
parent 21b27e3b56
commit 3a0d437359
2 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
core/modules/options/options.api.php
View File

@ -26,6 +26,7 @@ use Drupal\Core\Field\FieldStorageDefinitionInterface;
* - entity: The entity object the field is attached to * - entity: The entity object the field is attached to
* (\Drupal\Core\Entity\EntityInterface). * (\Drupal\Core\Entity\EntityInterface).
* *
* @ingroup hooks
* @see hook_options_list() * @see hook_options_list()
*/ */
function hook_options_list_alter(array &$options, array $context) { function hook_options_list_alter(array &$options, array $context) {
@ -42,7 +43,7 @@ function hook_options_list_alter(array &$options, array $context) {
* Callback for options_allowed_values(). * Callback for options_allowed_values().
* *
* 'list_*' fields can specify a callback to define the set of their allowed * 'list_*' fields can specify a callback to define the set of their allowed
* values using the 'allowed_values_callback' storage setting. * values using the 'allowed_values_function' storage setting.
* *
* That function will be called: * That function will be called:
* - either in the context of a specific entity, which is then provided as the * - either in the context of a specific entity, which is then provided as the
@ -74,6 +75,7 @@ function hook_options_list_alter(array &$options, array $context) {
* any context so that other code (e.g. Views filters) can support the allowed * any context so that other code (e.g. Views filters) can support the allowed
* values for all possible entities and bundles. * values for all possible entities and bundles.
* *
* @ingroup callbacks
* @see options_allowed_values() * @see options_allowed_values()
* @see options_test_allowed_values_callback() * @see options_test_allowed_values_callback()
* @see options_test_dynamic_values_callback() * @see options_test_dynamic_values_callback()

4
core/modules/options/tests/options_test/options_test.module
View File

@ -9,7 +9,7 @@ use Drupal\Core\Entity\FieldableEntityInterface;
use Drupal\Core\Field\FieldStorageDefinitionInterface; use Drupal\Core\Field\FieldStorageDefinitionInterface;
/** /**
* Allowed values callback. * Implements callback_allowed_values_function().
* *
* @see options_allowed_values(). * @see options_allowed_values().
*/ */
@ -31,7 +31,7 @@ function options_test_allowed_values_callback(FieldStorageDefinitionInterface $d
} }
/** /**
* An entity-bound allowed values callback. * Implements callback_allowed_values_function().
* *
* @todo This function violates the recommendation in options_allowed_values() * @todo This function violates the recommendation in options_allowed_values()
* to return a list of all possible values in any context when $items is * to return a list of all possible values in any context when $items is