summaryrefslogtreecommitdiffstatshomepage
path: root/modules/field/field.module
diff options
context:
space:
mode:
authorwebchick <webchick@24967.no-reply.drupal.org>2011-06-04 11:10:20 -0700
committerwebchick <webchick@24967.no-reply.drupal.org>2011-06-04 11:10:20 -0700
commit3588d0971f53a6bf942827fad37954e3fcfba4db (patch)
treec0f83334a01ac91ac42bb919b0b5c7cfa07b3ef5 /modules/field/field.module
parent4b5dfbc3bfd3724bf665b2325b4354f65d94af73 (diff)
downloaddrupal-3588d0971f53a6bf942827fad37954e3fcfba4db.tar.gz
drupal-3588d0971f53a6bf942827fad37954e3fcfba4db.zip
Issue #1017850 by yched: Improve documentation for field_view_value().
Diffstat (limited to 'modules/field/field.module')
-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 e9dbc659c21..b808e595691 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();