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

Issue #2009092 by smiletr: Fix up documentation for field_attach_view(), which was inaccurate for D8

8.0.x
Jennifer Hodgdon 2013-06-14 05:51:15 -07:00
parent a4cdbb065c
commit 4798dcf395
1 changed files with 3 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
core/modules/field/field.attach.inc
View File

@ -1410,7 +1410,7 @@ function field_attach_prepare_view($entity_type, array $entities, array $display
* Returns a renderable array for the fields on an entity. * Returns a renderable array for the fields on an entity.
* *
* Each field is displayed according to the display options specified in the * Each field is displayed according to the display options specified in the
* instance definition for the given view mode. * $display parameter for the given view mode.
* *
* field_attach_prepare_view() and field_attach_view() are two halves of the * field_attach_prepare_view() and field_attach_view() are two halves of the
* same operation. It is safe to call field_attach_prepare_view() multiple times * same operation. It is safe to call field_attach_prepare_view() multiple times
@ -1418,28 +1418,7 @@ function field_attach_prepare_view($entity_type, array $entities, array $display
* Field API operation on an entity between passing that entity to these two * Field API operation on an entity between passing that entity to these two
* functions may yield incorrect results. * functions may yield incorrect results.
* *
* Sample structure: * @param \Drupal\Core\Entity\EntityInterface $entity
* @code
* array(
* 'field_foo' => array(
* '#theme' => 'field',
* '#title' => the label of the field instance,
* '#label_display' => the label display mode,
* '#object' => the fieldable entity being displayed,
* '#entity_type' => the type of the entity being displayed,
* '#language' => the language of the field values being displayed,
* '#view_mode' => the view mode,
* '#field_name' => the name of the field,
* '#field_type' => the type of the field,
* '#formatter' => the name of the formatter,
* '#items' => the field values being displayed,
* // The element's children are the formatted values returned by
* // hook_field_formatter_view().
* ),
* );
* @endcode
*
* @param Drupal\Core\Entity\EntityInterface $entity
* The entity with fields to render. * The entity with fields to render.
* @param \Drupal\entity\Plugin\Core\Entity\EntityDisplay $display * @param \Drupal\entity\Plugin\Core\Entity\EntityDisplay $display
* The entity display object. * The entity display object.
@ -1448,7 +1427,7 @@ function field_attach_prepare_view($entity_type, array $entities, array $display
* provided the current language is used. * provided the current language is used.
* @param array $options * @param array $options
* An associative array of additional options. See field_invoke_method() for * An associative array of additional options. See field_invoke_method() for
* details. * details. Note: key "langcode" will be overridden inside this function.
* *
* @return array * @return array
* A renderable array for the field values. * A renderable array for the field values.