summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJennifer Hodgdon <yahgrp@poplarware.com>2013-10-17 16:22:53 -0700
committerJennifer Hodgdon <yahgrp@poplarware.com>2013-10-17 16:22:53 -0700
commita6a8a9fffd708f9561e139ec1f3fcc3e6929ebe2 (patch)
tree3f05d59d32e2800193db0a926f93d82cffa867f3
parented1df8f92e81258069f71ab2aea445209b72fd22 (diff)
downloadbrdo-a6a8a9fffd708f9561e139ec1f3fcc3e6929ebe2.tar.gz
brdo-a6a8a9fffd708f9561e139ec1f3fcc3e6929ebe2.tar.bz2
Issue #2109957 by ar-jan, joachim: Clarify docs for hook_field_schema()
-rw-r--r--modules/field/field.api.php7
1 files changed, 5 insertions, 2 deletions
diff --git a/modules/field/field.api.php b/modules/field/field.api.php
index 463da5514..04534db99 100644
--- a/modules/field/field.api.php
+++ b/modules/field/field.api.php
@@ -199,8 +199,11 @@ function hook_field_info_alter(&$info) {
/**
* Define the Field API schema for a field structure.
*
- * This hook MUST be defined in .install for it to be detected during
- * installation and upgrade.
+ * This is invoked when a field is created, in order to obtain the database
+ * schema from the module that defines the field's type.
+ *
+ * This hook must be defined in the module's .install file for it to be detected
+ * during installation and upgrade.
*
* @param $field
* A field structure.