Add help info for multi-record custom field sets
authorAidan Saunders <aidan.saunders@squiffle.uk>
Wed, 15 Dec 2021 15:45:12 +0000 (15:45 +0000)
committerAidan Saunders <aidan.saunders@squiffle.uk>
Wed, 15 Dec 2021 15:45:12 +0000 (15:45 +0000)
Civi/Api4/Generic/DAOGetAction.php

index e8a46ce5b54dc7e006e0fa1cb58b0be22a489969..94f1402f525d706e4ec993fce7767f2409b28174 100644 (file)
@@ -31,7 +31,9 @@ class DAOGetAction extends AbstractGetAction {
   /**
    * Fields to return. Defaults to all standard (non-custom, non-extra) fields `['*']`.
    *
-   * The keyword `"custom.*"` selects all custom fields. So to select all standard + custom fields, select `['*', 'custom.*']`.
+   * The keyword `"custom.*"` selects all custom fields (except those belonging to multi-record custom field sets). So to select all standard + custom fields, select `['*', 'custom.*']`.
+   *
+   * Multi-record custom field sets are represented as their own entity, so join to that entity to get those custom fields.
    *
    * Use the dot notation to perform joins in the select clause, e.g. selecting `['*', 'contact.*']` from `Email::get()`
    * will select all fields for the email + all fields for the related contact.