Drupal 8 8.0.2
|callback_batch_operation ($MULTIPLE_PARAMS, &$context)|
|callback_batch_finished ($success, $results, $operations)|
|callback_allowed_values_function (FieldStorageDefinitionInterface $definition, FieldableEntityInterface $entity=NULL, &$cacheable=TRUE)|
Callback function signatures.
Drupal's API sometimes uses callback functions to allow you to define how some type of processing happens. A callback is a function with a defined signature, which you define in a module. Then you pass the function name as a parameter to a Drupal API function or return it as part of a hook implementation return value, and your function is called at an appropriate time. For instance, when setting up batch processing you might need to provide a callback function for each processing step and/or a callback for when processing is finished; you would do that by defining these functions and passing their names into the batch setup function.
Callback function signatures, like hook definitions, are described by creating and documenting dummy functions in a *.api.php file; normally, the dummy callback function's name should start with "callback_", and you should document the parameters and return value and provide a sample function body. Then your API documentation can refer to this callback function in its documentation. A user of your API can usually name their callback function anything they want, although a standard name would be to replace "callback_" with the module name.
Provide the allowed values for a 'list_*' field.
Callback for options_allowed_values().
'list_*' fields can specify a callback to define the set of their allowed values using the 'allowed_values_function' storage setting.
That function will be called:
For consistency, the set of values returned when an $entity is provided should be a subset of the values returned when no $entity is provided.
|\Drupal\Core\Field\FieldStorageDefinitionInterface||$definition||The field storage definition.|
|\Drupal\Core\Entity\FieldableEntityInterface | null||$entity||(optional) The entity context if known, or NULL if the allowed values are being collected without the context of a specific entity.|
|bool||&$cacheable||(optional) If an $entity is provided, the $cacheable parameter should be modified by reference and set to FALSE if the set of allowed values returned was specifically adjusted for that entity and cannot not be reused for other entities. Defaults to TRUE.|
Complete a batch process.
Callback for batch_set().
This callback may be specified in a batch to perform clean-up operations, or to analyze the results of the batch operations.
|$success||A boolean indicating whether the batch has completed successfully.|
|$results||The value set in $context['results'] by callback_batch_operation().|
|$operations||If $success is FALSE, contains the operations that remained unprocessed.|
Perform a single batch operation.
Callback for batch_set().
|$MULTIPLE_PARAMS||Additional parameters specific to the batch. These are specified in the array passed to batch_set().|
|$context||The batch context array, passed by reference. This contains the following properties:|