summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorwebchick <webchick@24967.no-reply.drupal.org>2011-06-04 11:10:28 -0700
committerwebchick <webchick@24967.no-reply.drupal.org>2011-06-04 11:10:28 -0700
commit02d6d3541ac9c8f9b6cb7e14cffd58bdd0096fb4 (patch)
treef18fbcd159f403da59404ca494f2533e65d80d51
parent2647e116425d02e7b5c6207a7ea4a8f06080d4b1 (diff)
downloadbrdo-02d6d3541ac9c8f9b6cb7e14cffd58bdd0096fb4.tar.gz
brdo-02d6d3541ac9c8f9b6cb7e14cffd58bdd0096fb4.tar.bz2
Issue #1017850 by yched: Improve documentation for field_view_value().
-rw-r--r--modules/field/field.module4
1 files changed, 4 insertions, 0 deletions
diff --git a/modules/field/field.module b/modules/field/field.module
index e9dbc659c..b808e5956 100644
--- a/modules/field/field.module
+++ b/modules/field/field.module
@@ -825,6 +825,8 @@ function field_view_value($entity_type, $entity, $field_name, $item, $display =
* render($content[FIELD_NAME]) instead.
* - Do not use to display all fields in an entity, use
* field_attach_prepare_view() and field_attach_view() instead.
+ * - The field_view_value() function can be used to output a single formatted
+ * field value, without label or wrapping field markup.
*
* The function takes care of invoking the prepare_view steps. It also respects
* field access permissions.
@@ -864,6 +866,8 @@ function field_view_value($entity_type, $entity, $field_name, $item, $display =
* used.
* @return
* A renderable array for the field value.
+ *
+ * @see field_view_value()
*/
function field_view_field($entity_type, $entity, $field_name, $display = array(), $langcode = NULL) {
$output = array();