Added examples

Author: vinkla

.gitattributes

@@ -1,6 +1,7 @@
 * text=auto eol=lf
 
 /tests export-ignore
+/examples export-ignore
 /.github export-ignore
 /.editorconfig export-ignore
 /.gitattributes export-ignore

README.md

@@ -51,7 +51,7 @@ register_extended_field_group([
 ]);
 ```
 
-[Visit the official documentation to read more about the field group settings.](https://www.advancedcustomfields.com/resources/register-fields-via-php#group-settings)
+Find more examples in the [examples directory](examples) or [visit the official ACF documentation](https://www.advancedcustomfields.com/resources/register-fields-via-php#group-settings) to read more about the field group settings.
 
 ## Fields
 

examples/custom-post-type.php

@@ -0,0 +1,22 @@
+<?php
+
+use WordPlate\Acf\Fields\Email;
+use WordPlate\Acf\Fields\Text;
+use WordPlate\Acf\Location;
+
+register_extended_field_group([
+    'title' => 'Employee',
+    'fields' => [
+        Text::make('Title')
+            ->instructions('Add the employee title.')
+            ->required(),
+        Email::make('Email address', 'email')
+            ->instructions('Add the employee email address.')
+            ->required(),
+        Text::make('Phone number', 'phone')
+            ->instructions('Add the employee phone number.'),
+    ],
+    'location' => [
+        Location::if('post_type', 'employee'),
+    ],
+]);

examples/option-page.php

@@ -0,0 +1,34 @@
+<?php
+
+// This example is registering a option page using ACF. Please see the
+// documentation for more information:
+// https://www.advancedcustomfields.com/resources/acf_add_options_page/
+
+use WordPlate\Acf\Fields\Text;
+use WordPlate\Acf\Fields\Wysiwyg;
+use WordPlate\Acf\Location;
+
+acf_add_options_page([
+    'icon_url' => 'dashicons-star-filled',
+    'menu_slug' => 'cookie',
+    'page_title' => 'Cookie',
+    'position' => 21,
+]);
+
+register_extended_field_group([
+    'title' => 'Cookie',
+    'fields' => [
+        Wysiwyg::make('Text', 'cookie_text')
+            ->instructions('Add the cookie disclaimer text.')
+            ->mediaUpload(false)
+            ->toolbar('link')
+            ->tabs('visual')
+            ->required(),
+        Text::make('Label', 'cookie_label')
+            ->instructions('Add the button label.')
+            ->required(),
+    ],
+    'location' => [
+        Location::if('options_page', 'cookie'),
+    ],
+]);

examples/with-extended-cpts.php

@@ -0,0 +1,47 @@
+<?php
+
+// This example is using the Extended CPTs package to register custom post types
+// and taxanomies. Please see the repository for more information:
+// https://github.com/johnbillion/extended-cpts
+
+use WordPlate\Acf\Fields\Wysiwyg;
+use WordPlate\Acf\Location;
+
+register_extended_post_type('faq', [
+    'menu_icon' => 'dashicons-format-chat',
+    'has_archive' => false,
+    'supports' => ['title', 'revisions'],
+    'admin_cols' => [
+        'category' => [
+            'taxonomy' => 'topic',
+        ],
+    ],
+    'taxonomies' => ['topic'],
+], [
+    'singluar' => 'FAQ',
+    'plural' => 'FAQ',
+    'slug' => 'faq',
+]);
+
+register_extended_taxonomy('topic', 'faq', [
+    'hierarchical' => false,
+    'meta_box' => 'radio',
+    'required' => true,
+    'hierarchical' => false,
+    'show_in_rest' => true,
+]);
+
+register_extended_field_group([
+    'title' => 'FAQ',
+    'fields' => [
+        Wysiwyg::make('Answer')
+            ->instructions('Add the question answer.')
+            ->mediaUpload(false)
+            ->toolbar('faq')
+            ->tabs('visual')
+            ->required(),
+    ],
+    'location' => [
+        Location::if('post_type', 'faq'),
+    ],
+]);