defaultSort embedded element index config

brandonkelly · brandonkelly · commit f613051b0af4 · 2024-12-01T07:01:56.000-08:00
Resolves #16236
diff --git a/CHANGELOG-WIP.md b/CHANGELOG-WIP.md
@@ -38,6 +38,8 @@
 - Added `craft\mail\Mailer::$siteId`.
 - Added `craft\mail\Mailer::$siteOverrides`.
 - Added `craft\models\MailSettings::$siteOverrides`.
+- `craft\elements\NestedElementManager::getIndexHtml()` now supports passing `defaultSort` in the `$config` array. ([#16236](https://github.com/craftcms/cms/discussions/16236))
+- `craft\helpers\Cp::elementIndexHtml()` now supports passing `defaultSort` in the `$config` array, when `sources` is `null`. ([#16236](https://github.com/craftcms/cms/discussions/16236))
 - `craft\models\Site` now implements `craft\base\Chippable`.
 
 ### System
diff --git a/src/elements/NestedElementManager.php b/src/elements/NestedElementManager.php
@@ -458,6 +458,7 @@ public function getIndexHtml(?ElementInterface $owner, array $config = []): stri
             'allowedViewModes' => null,
             'showHeaderColumn' => true,
             'fieldLayouts' => [],
+            'defaultSort' => null,
             'defaultTableColumns' => null,
             'prevalidate' => false,
             'pageSize' => 50,
@@ -524,6 +525,7 @@ function(string $id, array $config, string $attribute, array &$settings) use ($o
                     'showSiteMenu' => false,
                     'sources' => false,
                     'fieldLayouts' => $config['fieldLayouts'],
+                    'defaultSort' => $config['defaultSort'],
                     'defaultTableColumns' => $config['defaultTableColumns'],
                     'defaultViewMode' => $config['defaultViewMode'],
                     'registerJs' => false,
diff --git a/src/helpers/Cp.php b/src/helpers/Cp.php
@@ -1197,6 +1197,7 @@ public static function elementIndexHtml(string $elementType, array $config = [])
             'showStatusMenu' => 'auto',
             'showSiteMenu' => 'auto',
             'fieldLayouts' => [],
+            'defaultSort' => null,
             'defaultTableColumns' => null,
             'registerJs' => true,
             'jsSettings' => [],
@@ -1291,6 +1292,7 @@ public static function elementIndexHtml(string $elementType, array $config = [])
                     'key' => '__IMP__',
                     'label' => Craft::t('app', 'All elements'),
                     'hasThumbs' => $elementType::hasThumbs(),
+                    'defaultSort' => $config['defaultSort'],
                     'defaultViewMode' => $config['defaultViewMode'],
                 ],
             ];
