From 893ca9e14068dac4fa60b09301250b013bdcd178 Mon Sep 17 00:00:00 2001
From: Jennifer Hodgdon <yahgrp@poplarware.com>
Date: Thu, 4 Apr 2013 15:43:37 -0700
Subject: [PATCH] Issue #1614108 by Xano, bartmcpherson: Add documentation to
hook_field_extra_fields for missing properties in return array
---
core/modules/field/field.api.php | 12 +++++++++---
1 file changed, 9 insertions(+), 3 deletions(-)
diff --git a/core/modules/field/field.api.php b/core/modules/field/field.api.php
index 1cf252dad5be..e4f8dfb8c5a3 100644
--- a/core/modules/field/field.api.php
+++ b/core/modules/field/field.api.php
@@ -25,16 +25,22 @@
* @see hook_field_extra_fields_alter()
*
* @return
- * A nested array of 'pseudo-field' components. Each list is nested within the
+ * A nested array of 'pseudo-field' elements. Each list is nested within the
* following keys: entity type, bundle name, context (either 'form' or
* 'display'). The keys are the name of the elements as appearing in the
* renderable array (either the entity form or the displayed entity). The
* value is an associative array:
- * - label: The human readable name of the component.
- * - description: A short description of the component contents.
+ * - label: The human readable name of the element.
+ * - description: A short description of the element contents.
* - weight: The default weight of the element.
* - visible: The default visibility of the element. Only for 'display'
* context.
+ * - edit: (optional) String containing markup (normally a link) used as the
+ * element's 'edit' operation in the administration interface. Only for
+ * 'form' context.
+ * - delete: (optional) String containing markup (normally a link) used as the
+ * element's 'delete' operation in the administration interface. Only for
+ * 'form' context.
*/
function hook_field_extra_fields() {
$extra = array();
--
GitLab