From: Aidan Saunders <aidan.saunders@squiffle.uk>
Date: Wed, 15 Dec 2021 15:45:12 +0000 (+0000)
Subject: Add help info for multi-record custom field sets
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=d836e5b3803c1d226bcb7857ab8861705cf8ceb2;p=civicrm-core.git

Add help info for multi-record custom field sets
---

diff --git a/Civi/Api4/Generic/DAOGetAction.php b/Civi/Api4/Generic/DAOGetAction.php
index e8a46ce5b5..94f1402f52 100644
--- a/Civi/Api4/Generic/DAOGetAction.php
+++ b/Civi/Api4/Generic/DAOGetAction.php
@@ -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.