enhance(defaults): Move field_group defaults out of build()

Improve `acf.php` config documentation
Log1x · Jan 4, 2020 · 1aa4960 · 1aa4960
1 parent 5579322
commit 1aa4960
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 13 deletions.
diff --git a/config/acf.php b/config/acf.php
@@ -35,12 +35,17 @@
     | Default Field Type Settings
     |--------------------------------------------------------------------------
     |
-    | Here you can set default field type settings that are automatically
-    | applied to the field types when built.
+    | Here you can set default field group and field type configuration that
+    | is then merged with your field groups when they are composed.
+    |
+    | This allows you to avoid the repetitive process of setting common field
+    | configuration such as `ui` on every `trueFalse` field or
+    | `instruction_placement` on every `fieldGroup`.
     |
     */
 
     'defaults' => [
         'trueFalse' => ['ui' => 1],
+        'select' => ['ui' => 1],
     ],
 ];
diff --git a/src/Block.php b/src/Block.php
@@ -222,6 +222,10 @@ public function compose()
             ]);
 
             if (! empty($this->fields)) {
+                if ($this->defaults->has('field_group')) {
+                    $this->fields = array_merge($this->fields, $this->defaults->get('field_group'));
+                }
+
                 if (! Arr::has($this->fields, 'location.0.0')) {
                     Arr::set($this->fields, 'location.0.0', [
                         'param' => 'block',
@@ -243,10 +247,6 @@ public function compose()
      */
     protected function build($fields = [])
     {
-        if (empty($fields) && $this->defaults->has('field_group')) {
-            $this->fields = array_merge($this->fields, $this->defaults->get('field_group'));
-        }
-
         return collect($fields ?: $this->fields)->map(function ($value, $key) use ($fields) {
             if (
                 ! Str::contains($key, ['fields', 'sub_fields', 'layouts']) ||

diff --git a/src/Field.php b/src/Field.php
@@ -54,15 +54,22 @@ public function compose()
         }
 
         $this->fields = $this->fields();
+
         $this->defaults = collect(
             $this->app->config->get('acf.defaults')
         )->merge($this->defaults)->mapWithKeys(function ($value, $key) {
             return [Str::snake($key) => $value];
         });
 
-        add_action('init', function () {
-            acf_add_local_field_group($this->build());
-        }, 20);
+        if (! empty($this->fields)) {
+            add_action('init', function () {
+                if ($this->defaults->has('field_group')) {
+                    $this->fields = array_merge($this->fields, $this->defaults->get('field_group'));
+                }
+
+                acf_add_local_field_group($this->build());
+            }, 20);
+        }
     }
 
     /**
@@ -73,10 +80,6 @@ public function compose()
      */
     protected function build($fields = [])
     {
-        if (empty($fields) && $this->defaults->has('field_group')) {
-            $this->fields = array_merge($this->fields, $this->defaults->get('field_group'));
-        }
-
         return collect($fields ?: $this->fields)->map(function ($value, $key) use ($fields) {
             if (
                 ! Str::contains($key, ['fields', 'sub_fields', 'layouts']) ||