summaryrefslogtreecommitdiff
path: root/modules
diff options
context:
space:
mode:
authorDries Buytaert <dries@buytaert.net>2011-01-11 13:40:06 +0000
committerDries Buytaert <dries@buytaert.net>2011-01-11 13:40:06 +0000
commiteeadb9397cb7ec51f82d7081ccee855638f31cef (patch)
treebd7e97be8bf953fcaf6e2903d1a1377628676d52 /modules
parent3fc4d71523fc6e389ec522ec689a89dac05a6005 (diff)
downloadbrdo-eeadb9397cb7ec51f82d7081ccee855638f31cef.tar.gz
brdo-eeadb9397cb7ec51f82d7081ccee855638f31cef.tar.bz2
- Patch #1014762 by jhodgdon: hook_entity_info() documentation outdated.
Diffstat (limited to 'modules')
-rw-r--r--modules/system/system.api.php21
1 files changed, 12 insertions, 9 deletions
diff --git a/modules/system/system.api.php b/modules/system/system.api.php
index fcc3a37c3..1356dd629 100644
--- a/modules/system/system.api.php
+++ b/modules/system/system.api.php
@@ -123,12 +123,15 @@ function hook_hook_info_alter(&$hooks) {
* build the label, a 'label callback' should be defined instead (see
* the 'label callback' section above for details).
* - bundle keys: An array describing how the Field API can extract the
- * information it needs from the bundle objects for this type (e.g
- * $vocabulary objects for terms; not applicable for nodes). This entry can
- * be omitted if this type's bundles do not exist as standalone objects.
- * Elements:
- * - bundle: The name of the property that contains the name of the bundle
- * object.
+ * information it needs from the bundle objects for this type. This entry
+ * is required if the 'path' provided in the 'bundles'/'admin' section
+ * identifies the bundle using a named menu placeholder whose loader
+ * callback returns an object (e.g., $vocabulary for taxonomy terms, or
+ * $node_type for nodes). If the path does not include the bundle, or the
+ * bundle is just a string rather than an automatically loaded object, then
+ * this can be omitted. Elements:
+ * - bundle: The name of the property of the bundle object that contains
+ * the name of the bundle object.
* - bundles: An array describing all bundles for this object type. Keys are
* bundles machine names, as found in the objects' 'bundle' property
* (defined in the 'entity keys' entry above). Elements:
@@ -142,9 +145,9 @@ function hook_hook_info_alter(&$hooks) {
* Elements:
* - path: the path of the bundle's main administration page, as defined
* in hook_menu(). If the path includes a placeholder for the bundle,
- * the 'bundle argument', 'bundle helper' and 'real path' keys below
- * are required.
- * - bundle argument: The position of the placeholder in 'path', if any.
+ * the 'bundle argument' and 'real path' keys below are required.
+ * - bundle argument: The position of the bundle placeholder in 'path', if
+ * any.
* - real path: The actual path (no placeholder) of the bundle's main
* administration page. This will be used to generate links.
* - access callback: As in hook_menu(). 'user_access' will be assumed if