summaryrefslogtreecommitdiffstatshomepage
path: root/modules/field/field.module
diff options
context:
space:
mode:
authorDries Buytaert <dries@buytaert.net>2010-04-13 15:23:03 +0000
committerDries Buytaert <dries@buytaert.net>2010-04-13 15:23:03 +0000
commit3c3cee28b94eb0c14f6958e1e6440bba15bc9a7d (patch)
tree4bd9c67db94feb06249cc2727dd3a5e935f58e12 /modules/field/field.module
parentf8e14898d636ceae44a9980105da903f57d2deef (diff)
downloaddrupal-3c3cee28b94eb0c14f6958e1e6440bba15bc9a7d.tar.gz
drupal-3c3cee28b94eb0c14f6958e1e6440bba15bc9a7d.zip
- Patch #716496 by JohnAlbin: documentation updates for theme functions.
Diffstat (limited to 'modules/field/field.module')
-rw-r--r--modules/field/field.module14
1 files changed, 13 insertions, 1 deletions
diff --git a/modules/field/field.module b/modules/field/field.module
index c3765cfaa3d..d470c9fd71d 100644
--- a/modules/field/field.module
+++ b/modules/field/field.module
@@ -790,7 +790,7 @@ function template_process_field(&$variables, $hook) {
*/
/**
- * Returns a themed field.
+ * Returns HTML for a field.
*
* This is the default theme implementation to display the value of a field.
* Theme developers who are comfortable with overriding theme functions may do
@@ -831,6 +831,18 @@ function template_process_field(&$variables, $hook) {
* the exact performance impact depends on the server configuration and the
* details of the website.
*
+ * @param $variables
+ * An associative array containing:
+ * - label_hidden: A boolean indicating to show or hide the field label.
+ * - title_attributes: A string containing the attributes for the title.
+ * - label: The label for the field.
+ * - content_attributes: A string containing the attaributes for the content's
+ * div.
+ * - items: An array of field items.
+ * - item_attributes: An array of attributes for each item.
+ * - classes: A string containing the classes for the wrapping div.
+ * - attributes: A string containing the attributes for the wrapping div.
+ *
* @see template_preprocess_field()
* @see template_process_field()
* @see field.tpl.php