summaryrefslogtreecommitdiff
path: root/modules/field
diff options
context:
space:
mode:
authorJennifer Hodgdon <yahgrp@poplarware.com>2013-04-23 07:39:56 -0700
committerJennifer Hodgdon <yahgrp@poplarware.com>2013-04-23 07:39:56 -0700
commit496e56b341bad6a6517adba600b757ed01efecce (patch)
tree7d9f6c11b6217e661205f6041ec04b6557a7ab1d /modules/field
parent694dc23de4bd393b0852dc51569f8a30047b7e39 (diff)
downloadbrdo-496e56b341bad6a6517adba600b757ed01efecce.tar.gz
brdo-496e56b341bad6a6517adba600b757ed01efecce.tar.bz2
Issue #1973762 by chx, cosmicdreams, yched: Add example to field_info_field_map return docs
Diffstat (limited to 'modules/field')
-rw-r--r--modules/field/field.info.inc11
1 files changed, 11 insertions, 0 deletions
diff --git a/modules/field/field.info.inc b/modules/field/field.info.inc
index 396ad5fd1..02b3c9ca4 100644
--- a/modules/field/field.info.inc
+++ b/modules/field/field.info.inc
@@ -449,6 +449,17 @@ function field_info_bundles($entity_type = NULL) {
* - type: The field type.
* - bundles: The bundles in which the field appears, as an array with entity
* types as keys and the array of bundle names as values.
+ * Example:
+ * @code
+ * array(
+ * 'body' => array(
+ * 'bundles' => array(
+ * 'node' => array('page', 'article'),
+ * ),
+ * 'type' => 'text_with_summary',
+ * ),
+ * );
+ * @endcode
*/
function field_info_field_map() {
$cache = _field_info_field_cache();