PHPackages                             wordplate/acf - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. wordplate/acf

Abandoned → [vinkla/extended-acf](/?search=vinkla%2Fextended-acf)Library[Utility & Helpers](/categories/utility)

wordplate/acf
=============

Register advanced custom fields with object-oriented PHP

15.0.0(2mo ago)503144.8k↓46.9%59[1 issues](https://github.com/vinkla/extended-acf/issues)10MITPHPPHP ^8.4CI passing

Since Apr 7Pushed 1mo ago15 watchersCompare

[ Source](https://github.com/vinkla/extended-acf)[ Packagist](https://packagist.org/packages/wordplate/acf)[ RSS](/packages/wordplate-acf/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (4)Versions (79)Used By (10)

[![Extended ACF](https://user-images.githubusercontent.com/499192/34915298-1782a500-f924-11e7-85a7-dc7de6aacc14.png)](https://user-images.githubusercontent.com/499192/34915298-1782a500-f924-11e7-85a7-dc7de6aacc14.png)

Extended ACF
============

[](#extended-acf)

> Register [advanced custom fields](https://www.advancedcustomfields.com) with object-oriented PHP.

Extended ACF provides an object-oriented API to register groups and fields with ACF. If you register fields in your theme, you can safely rely on version control when working with other developers. Oh, you don't have to worry about unique field keys.

[![Build Status](https://camo.githubusercontent.com/5dad92288856be36e34d23e3ff923095b7696468fc02ce3cf9f9ec5485bc2b2c/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f76696e6b6c612f657874656e6465642d6163662f706870756e69742e796d6c3f6272616e63683d6d6173746572266c6162656c3d7465737473)](https://github.com/vinkla/extended-acf/actions)[![Monthly Downloads](https://camo.githubusercontent.com/2d8c8d5c585e7f276c305643c31f28184e1d2e29d4ebbf5fbcbd859572001c47/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f646d2f76696e6b6c612f657874656e6465642d616366)](https://packagist.org/packages/vinkla/extended-acf/stats)[![Latest Version](https://camo.githubusercontent.com/6adcd1e51144356d45ac0d548d42cc45d1857e6aa599f0939222efca661ffc46/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f76696e6b6c612f657874656e6465642d616366)](https://packagist.org/packages/vinkla/extended-acf)

- [Installation](#installation)
- [Usage](#usage)
- [Settings](#settings)
- [Fields](#fields)
    - [Basic](#basic)
    - [Content](#content)
    - [Choice](#choice)
    - [Relational](#relational)
    - [Advanced](#advanced)
    - [Layout](#layout)
- [Location](#location)
- [Conditional Logic](#conditional-logic)
- [Bidirectional Relationships](#bidirectional-relationships)
- [Non-standards](#non-standards)
    - [`helperText`](#helperText)
    - [`column`](#column)
    - [`dd` and `dump`](#dd-and-dump)
    - [`key`](#key)
    - [`withSettings`](#withsettings)
- [Macros](#macros)
- [Custom Fields](#custom-fields)
- [Upgrade Guide](#upgrade-guide)

Installation
------------

[](#installation)

Require this package, with Composer, in the root directory of your project.

```
composer require vinkla/extended-acf
```

To install the [Advanced Custom Fields Pro](https://www.advancedcustomfields.com/blog/composer-support-acf-pro/) plugin, download and place it in either the `plugins` or `mu-plugins` directory. After that, activate the plugin in the WordPress dashboard.

[Learn more about installing ACF PRO using Composer.](https://www.advancedcustomfields.com/resources/installing-acf-pro-with-composer/)

Usage
-----

[](#usage)

To register a new field group, use the `register_extended_field_group()` function. This extends the default [`register_field_group()`](https://www.advancedcustomfields.com/resources/register-fields-via-php#example) function from the ACF plugin. The `key` value is appended to field groups and fields. Here's an example of a field group.

```
use Extended\ACF\Fields\Image;
use Extended\ACF\Fields\Text;
use Extended\ACF\Location;

add_action('acf/include_fields', function() {
    register_extended_field_group([
        'title' => 'About',
        'fields' => [
            Image::make('Image'),
            Text::make('Title'),
        ],
        'location' => [
            Location::where('post_type', 'page')
        ],
    ]);
});
```

Settings
--------

[](#settings)

For detailed information on field group settings, please consult the [official ACF documentation](https://www.advancedcustomfields.com/resources/register-fields-via-php#group-settings). You can also find more examples in the examples directory.

- [Register custom post type](examples/custom-post-type.php)
- [Register custom post type with Extended CPT](examples/with-extended-cpts.php)
- [Register Gutenberg block](examples/gutenberg-block.php)
- [Register options page](examples/options-page.php)

Fields
------

[](#fields)

All fields, except the clone field, have a corresponding class. Each field needs a `label`. If no `name` is specified, the `label` will be used as the `name` in snake\_case. The `name` can only contain alphanumeric characters and underscores.

```
use Extended\ACF\Fields\Text;

Text::make('Title', 'heading')
    ->helperText('Add the text value')
    ->required()
```

Most fields have the methods `default`, `required`, and `wrapper`. The [basic fields](#basic) also have the methods `prepend`, `append`, `placeholder`, `readOnly`, and `disabled`. Please also check the non-standard methods mentioned in the [non-standards](#non-standards) section.

### Basic

[](#basic)

**Email** - The [email field](https://www.advancedcustomfields.com/resources/text) creates a simple email input.

```
use Extended\ACF\Fields\Email;

Email::make('Email')
    ->helperText('Add the employees email address.')
    ->required()
```

**Number** - The [number field](https://www.advancedcustomfields.com/resources/text) creates a simple number input.

```
use Extended\ACF\Fields\Number;

Number::make('Age')
    ->helperText('Add the employees age.')
    ->min(18)
    ->max(65)
    ->required()
```

**Password** - The [password field](https://www.advancedcustomfields.com/resources/text) creates a simple password input.

```
use Extended\ACF\Fields\Password;

Password::make('Password')
    ->helperText('Add the employees secret pwned password.')
    ->required()
```

**Range** - The [range](https://www.advancedcustomfields.com/resources/range) field provides an interactive experience for selecting a numerical value.

```
use Extended\ACF\Fields\Range;

Range::make('Rate')
    ->helperText('Add the employees completion rate.')
    ->min(0)
    ->max(100)
    ->step(10)
    ->required()
```

**Text** - The [text field](https://www.advancedcustomfields.com/resources/text) creates a simple text input.

```
use Extended\ACF\Fields\Text;

Text::make('Name')
    ->helperText('Add the employees name.')
    ->maxLength(100)
    ->required()
```

**Textarea** - The [textarea field](https://www.advancedcustomfields.com/resources/textarea) creates a simple textarea.

```
use Extended\ACF\Fields\Textarea;

Textarea::make('Biography')
    ->helperText('Add the employees biography.')
    ->newLines('br') // br, wpautop
    ->maxLength(2000)
    ->rows(10)
    ->required()
```

**URL** - The [URL field](https://www.advancedcustomfields.com/resources/url/) creates a simple uRL input.

```
use Extended\ACF\Fields\URL;

URL::make('Website')
    ->helperText('Add the employees website link.')
    ->required()
```

### Content

[](#content)

**File** - The [file field](https://www.advancedcustomfields.com/resources/file) allows a file to be uploaded and selected.

```
use Extended\ACF\Fields\File;

File::make('Resturant Menu', 'menu')
    ->helperText('Add the menu **pdf** file.')
    ->acceptedFileTypes(['pdf'])
    ->library('all') // all, uploadedTo
    ->minSize('400 KB')
    ->maxSize(5) // MB if entered as int
    ->format('array') // id, url, array (default)
    ->required()
```

**Gallery** - The [gallery field](https://www.advancedcustomfields.com/resources/gallery) provides a simple and intuitive interface for managing a collection of images.

```
use Extended\ACF\Fields\Gallery;

Gallery::make('Images')
    ->helperText('Add the gallery images.')
    ->acceptedFileTypes(['jpg', 'jpeg', 'png'])
    ->minHeight(500)
    ->maxHeight(1400)
    ->minWidth(1000)
    ->maxWidth(2000)
    ->minFiles(1)
    ->maxFiles(6)
    ->minSize('400 KB')
    ->maxSize(5) // MB if entered as int
    ->library('all') // all, uploadedTo
    ->format('array') // id, url, array (default)
    ->previewSize('medium') // thumbnail, medium, large
    ->prependFiles()
    ->required()
```

**Image** - The [image field](https://www.advancedcustomfields.com/resources/image) allows an image to be uploaded and selected.

```
use Extended\ACF\Fields\Image;

Image::make('Background Image')
    ->helperText('Add an image in at least 12000x100px and only in the formats **jpg**, **jpeg** or **png**.')
    ->acceptedFileTypes(['jpg', 'jpeg', 'png'])
    ->minHeight(500)
    ->maxHeight(1400)
    ->minWidth(1000)
    ->maxWidth(2000)
    ->minSize('400 KB')
    ->maxSize(5) // MB if entered as int
    ->library('all') // all, uploadedTo
    ->format('array') // id, url, array (default)
    ->previewSize('medium') // thumbnail, medium, large
    ->required()
```

**Oembed** - The [oEmbed field](https://www.advancedcustomfields.com/resources/oembed) allows an easy way to embed videos, images, tweets, audio, and other content.

```
use Extended\ACF\Fields\Oembed;

Oembed::make('Tweet')
    ->helperText('Add a tweet from Twitter.')
    ->required()
```

**WYSIWYG** - The [WYSIWYG field](https://www.advancedcustomfields.com/resources/wysiwyg-editor) creates a full WordPress tinyMCE content editor.

```
use Extended\ACF\Fields\WYSIWYGEditor;

WYSIWYGEditor::make('Content')
    ->helperText('Add the text content.')
    ->tabs('visual') // all, text, visual (default)
    ->toolbar(['bold', 'italic', 'link']) // aligncenter, alignleft, alignright, blockquote, bold, bullist, charmap, forecolor, formatselect, fullscreen, hr, indent, italic, link, numlist, outdent, pastetext, redo, removeformat, spellchecker, strikethrough, underline, undo, wp_adv, wp_help, wp_more
    ->disableMediaUpload()
    ->lazyLoad()
    ->required()
```

### Choice

[](#choice)

**Button Group** - The [button group](https://www.advancedcustomfields.com/resources/button-group) field creates a list of radio buttons.

```
use Extended\ACF\Fields\ButtonGroup;

ButtonGroup::make('Color')
    ->helperText('Select the box shadow color.')
    ->choices(['Forest Green', 'Sky Blue']) // ['forest_green' => 'Forest Green', 'sky_blue' => 'Sky Blue']
    ->default('forest_green')
    ->format('value') // array, label, value (default)
    ->required()
```

**Checkbox** - The [checkbox field](https://www.advancedcustomfields.com/resources/checkbox) creates a list of tick-able inputs.

```
use Extended\ACF\Fields\Checkbox;

Checkbox::make('Color')
    ->helperText('Select the border color.')
    ->choices(['Forest Green', 'Sky Blue']) // ['forest_green' => 'Forest Green', 'sky_blue' => 'Sky Blue']
    ->default('forest_green')
    ->format('value') // array, label, value (default)
    ->layout('horizontal') // vertical, horizontal
    ->required()
```

**Radio Button** - The [radio button field](https://www.advancedcustomfields.com/resources/radio-button) creates a list of select-able inputs.

```
use Extended\ACF\Fields\RadioButton;

RadioButton::make('Color')
    ->helperText('Select the text color.')
    ->choices(['Forest Green', 'Sky Blue']) // ['forest_green' => 'Forest Green', 'sky_blue' => 'Sky Blue']
    ->default('forest_green')
    ->format('value') // array, label, value (default)
    ->required()
```

**Select** - The [select field](https://www.advancedcustomfields.com/resources/select) creates a drop down select or multiple select input.

```
use Extended\ACF\Fields\Select;

Select::make('Color')
    ->helperText('Select the background color.')
    ->choices(['Forest Green', 'Sky Blue']) // ['forest_green' => 'Forest Green', 'sky_blue' => 'Sky Blue']
    ->default('forest_green')
    ->format('value') // array, label, value (default)
    ->multiple()
    ->nullable()
    ->stylized() // stylized checkbox using select2
    ->lazyLoad() // use AJAX to lazy load choices
    ->create() // allow creation of new options
    ->save() // save new options to the choices
    ->required()
```

**True False** - The [true / false field](https://www.advancedcustomfields.com/resources/true-false) allows you to select a value that is either 1 or 0.

```
use Extended\ACF\Fields\TrueFalse;

TrueFalse::make('Social Media', 'display_social_media')
    ->helperText('Select whether to display social media links or not.')
    ->default(false)
    ->stylized(on: 'Yes', off: 'No') // optional on and off text labels
    ->required()
```

### Relational

[](#relational)

**Link** - The [link field](https://www.advancedcustomfields.com/resources/link) provides a simple way to select or define a link (url, title, target).

```
use Extended\ACF\Fields\Link;

Link::make('Read More Link')
    ->format('array') // url, array (default)
    ->required()
```

**Page Link** - The [page link field](https://www.advancedcustomfields.com/resources/page-link) allows the selection of 1 or more posts, pages or custom post types.

```
use Extended\ACF\Fields\PageLink;

PageLink::make('Contact Link')
    ->postTypes(['contact'])
    ->postStatus(['publish']) // draft, future, pending, private, publish
    ->taxonomies(['category:city'])
    ->disableArchives()
    ->nullable()
    ->multiple()
    ->required()
```

**Post Object** - The [post object field](https://www.advancedcustomfields.com/resources/post-object) creates a select field where the choices are your pages + posts + custom post types.

```
use Extended\ACF\Fields\PostObject;

PostObject::make('Animal')
    ->helperText('Select an animal')
    ->postTypes(['animal'])
    ->postStatus(['publish']) // draft, future, pending, private, publish
    ->nullable()
    ->multiple()
    ->format('object') // id, object (default)
    ->required()
```

**Relationship** - The [relationship field](https://www.advancedcustomfields.com/resources/relationship) creates a very attractive version of the post object field.

```
use Extended\ACF\Fields\Relationship;

Relationship::make('Contacts')
    ->helperText('Add the contacts.')
    ->postTypes(['contact'])
    ->postStatus(['publish']) // draft, future, pending, private, publish
    ->filters([
        'search',
        'post_type',
        'taxonomy'
    ])
    ->elements(['featured_image'])
    ->minPosts(3)
    ->maxPosts(6)
    ->format('object') // id, object (default)
    ->required()
```

**Taxonomy** - The [taxonomy field](https://www.advancedcustomfields.com/resources/taxonomy) allows the selection of 1 or more taxonomy terms.

```
use Extended\ACF\Fields\Taxonomy;

Taxonomy::make('Cinemas')
    ->helperText('Select one or more cinema terms.')
    ->taxonomy('cinema')
    ->appearance('checkbox') // checkbox, multi_select, radio, select
    ->create(false) // false or true (default)
    ->load(true) // true or false (default)
    ->save(true) // true or false (default)x
    ->format('id'), // object, id (default)
```

**User** - The user field creates a select field for all your users.

```
use Extended\ACF\Fields\User;

User::make('User')
    ->roles(['administrator', 'editor']) // administrator, author, contributor, editor, subscriber
    ->format('array'), // id, object, array (default)
```

### Advanced

[](#advanced)

**Color Picker** - The [color picker field](https://www.advancedcustomfields.com/resources/color-picker) allows a color to be selected via a JavaScript popup.

```
use Extended\ACF\Fields\ColorPicker;

ColorPicker::make('Text Color')
    ->helperText('Add the text color.')
    ->default('#4a9cff')
    ->opacity()
    ->format('string') // array, string (default)
    ->palette(['#111111', '#222222', '#333333']) // custom color palette
    ->disableColorWheel() // restrict to palette colors only
    ->required()
```

**Date Picker** - The [date picker field](https://www.advancedcustomfields.com/resources/date-picker) creates a jQuery date selection popup.

```
use Extended\ACF\Fields\DatePicker;

DatePicker::make('Birthday')
    ->helperText('Add the employee\'s birthday.')
    ->displayFormat('d/m/Y')
    ->format('d/m/Y')
    ->defaultNow() // default to current date
    ->required()
```

**Icon Picker** - The [icon picker field](https://www.advancedcustomfields.com/resources/icon-picker) allows you to easily select a Dashicon, a Media Library image, or a URL for an image or SVG.

```
use Extended\ACF\Fields\IconPicker;

IconPicker::make('Icon')
    ->helperText('Add the icon.')
    ->format('string') // array, string (default)
    ->tabs(['dashicons']) // [dashicons, media_library, url] (default)
    ->required()
```

**Time Picker** - The [time picker field](https://www.advancedcustomfields.com/resources/time-picker) creates a jQuery time selection popup.

```
use Extended\ACF\Fields\TimePicker;

TimePicker::make('Start Time', 'time')
    ->helperText('Add the start time.')
    ->displayFormat('H:i')
    ->format('H:i')
    ->required()
```

**Date Time Picker** - The [date time picker field](https://www.advancedcustomfields.com/resources/date-time-picker) creates a jQuery date & time selection popup.

```
use Extended\ACF\Fields\DateTimePicker;

DateTimePicker::make('Event Date', 'date')
    ->helperText('Add the event\'s start date and time.')
    ->displayFormat('d-m-Y H:i')
    ->format('d-m-Y H:i')
    ->firstDayOfWeek(1) // Sunday is 0, Monday is 1, or use `weekStartsOnMonday` or `weekStartsOnSunday`
    ->defaultNow() // default to current date
    ->required()
```

**Google Map** - The [Google Map field](https://www.advancedcustomfields.com/resources/google-map) creates an interactive map with the ability to place a marker.

```
use Extended\ACF\Fields\GoogleMap;

GoogleMap::make('Address', 'address')
    ->helperText('Add the Google Map address.')
    ->center(57.456286, 18.377716)
    ->zoom(14)
    ->required()
```

### Layout

[](#layout)

**Accordion** - The [accordion field](https://www.advancedcustomfields.com/resources/accordion) is used to organize fields into collapsible panels.

```
use Extended\ACF\Fields\Accordion;

Accordion::make('Address')
    ->open()
    ->multiExpand(),

// Allow accordion to remain open when other accordions are opened.
// Any field after this accordion will become a child.

Accordion::make('Endpoint')
    ->endpoint()
    ->multiExpand(),

// This field will not be visible, but will end the accordion above.
// Any fields added after this will not be a child to the accordion.
```

**Clone** - The [clone field](https://www.advancedcustomfields.com/resources/clone) enables you to choose and showcase pre-existing fields or groups. This field does not possess a custom field class. Instead, you can create a new file for your field and import it using the `require` statement whenever necessary.

```
// fields/email.php
use Extended\ACF\Fields\Email;

return Email::make('Email')->required();

// employee.php
register_extended_field_group([
    'fields' => [
        require __DIR__.'/fields/email.php';
    ]
]);
```

**Flexible Content** - The [flexible content field](https://www.advancedcustomfields.com/resources/flexible-content) acts as a blank canvas to which you can add an unlimited number of layouts with full control over the order.

```
use Extended\ACF\Fields\FlexibleContent;
use Extended\ACF\Fields\Layout;
use Extended\ACF\Fields\Text;

FlexibleContent::make('Blocks')
    ->helperText('Add the page blocks.')
    ->button('Add Component')
    ->layouts([
        Layout::make('Image')
            ->layout('block')
            ->fields([
                Text::make('Description')
            ])
    ])
    ->minLayouts(1)
    ->maxLayouts(10)
    ->required()
```

**Group** - The [group](https://www.advancedcustomfields.com/resources/group) allows you to create a group of sub fields.

```
use Extended\ACF\Fields\Group;
use Extended\ACF\Fields\Image;
use Extended\ACF\Fields\Text;

Group::make('Hero')
    ->helperText('Add a hero block with title, content and image to the page.')
    ->fields([
        Text::make('Title'),
        Image::make('Background Image'),
    ])
    ->layout('row')
    ->required()
```

**Message** - The message fields allows you to display a text message.

```
use Extended\ACF\Fields\Message;

Message::make('Heading')
    ->body('George. One point twenty-one gigawatts.')
    ->escapeHtml(),
```

**Repeater** - The [repeater field](https://www.advancedcustomfields.com/resources/repeater) allows you to create a set of sub fields which can be repeated again and again whilst editing content!

```
use Extended\ACF\Fields\Image;
use Extended\ACF\Fields\Repeater;
use Extended\ACF\Fields\Text;

Repeater::make('Employees')
    ->helperText('Add the employees.')
    ->fields([
        Text::make('Name'),
        Image::make('Profile Picture'),
    ])
    ->minRows(2)
    ->maxRows(10)
    ->collapsed('name')
    ->button('Add employee')
    ->paginated(10)
    ->layout('table') // block, row, table
    ->required()
```

**Tab** - The [tab field](https://www.advancedcustomfields.com/resources/tab) groups fields into tabbed sections. Fields or groups added after a tab become its children. Enabling `endpoint` on a tab creates a new group of tabs.

```
use Extended\ACF\Fields\Tab;

Tab::make('Tab 1'),
Tab::make('Tab 2'),
Tab::make('Tab 3')
    ->placement('top') // top, left
    ->selected() // specify which tab should be selected by default
    ->endpoint(), // This will make a break in the tabs and create a new group of tabs
```

Location
--------

[](#location)

The `Location` class allows you to write custom location rules without specifying the `name`, `operator`, and `value` keys. If no `operator` is provided, it will use the `operator` as the `value`. For additional details on custom location rules, please visit [this link](https://www.advancedcustomfields.com/resources/custom-location-rules).

```
use Extended\ACF\Location;

Location::where('post_type', 'post')->and('post_type', '!=', 'post') // available operators: ==, !=
```

Note

The `if` method was renamed to `where` in version 12, see the [upgrade guide](#upgrade-guide).

Conditional Logic
-----------------

[](#conditional-logic)

The conditional class helps you write conditional logic [without knowing](https://media.giphy.com/media/SbtWGvMSmJIaV8faS8/source.gif) the field keys.

```
use Extended\ACF\ConditionalLogic;
use Extended\ACF\Fields\File;
use Extended\ACF\Fields\Select;
use Extended\ACF\Fields\URL;
use Extended\ACF\Fields\Textarea;
use Extended\ACF\Fields\Text;

Select::make('Type')
    ->choices([
        'document' => 'Document',
        'link' => 'Link to resource',
        'embed' => 'Embed',
    ]),
File::make('Document', 'file')
    ->conditionalLogic([
        ConditionalLogic::where('type', '==', 'document') // available operators: ==, !=, >, conditionalLogic([
        ConditionalLogic::where('type', '==', 'link')
    ]),

// "and" condition
Textarea::make('Embed Code')
    ->conditionalLogic([
        ConditionalLogic::where('type', '!=', 'document')->and('type', '!=', 'link')
    ]),

// use multiple conditional logic for "or" condition
Text::make('Title')
    ->conditionalLogic([
        ConditionalLogic::where('type', '!=', 'document'),
        ConditionalLogic::where('type', '!=', 'link')
    ]),

// conditional logic that relies on another field from a different field group
Text::make('Sub Title')
    ->conditionalLogic([
      ConditionalLogic::where(
        group: 'other-group',
        name: 'enable_highlight',
        operator: '==',
        value: 'on',
      )
    ]),
```

Bidirectional Relationships
---------------------------

[](#bidirectional-relationships)

The `bidirectional` method establishes a bidirectional relationship between two or more fields. Each field involved in this relationship must use the `key` method to set a custom key. Then, the keys of these related fields should be passed to the `bidirectional` method.

```
use Extended\ACF\Fields\Relationship;

// This field is attached to a "Project" post type.
Relationship::make('Related Testimonial')
  ->postTypes(['testimonial'])
  ->key('field_related_testimonial')
  ->bidirectional('field_related_project'),

// This field is attached to a "Testimonial" post type.
Relationship::make('Related Project')
  ->postTypes(['project'])
  ->key('field_related_project')
  ->bidirectional('field_related_testimonial'),
```

To learn more about ACF bidirectional relationships and their caveats, please consult the [official ACF documentation](https://www.advancedcustomfields.com/resources/bidirectional-relationships/).

Important

We [usually recommend avoiding](#key) the use of custom field keys. This is an exception to that rule. When using bidirectional relationships, you must set custom field keys.

Non-standards
-------------

[](#non-standards)

### `helperText`

[](#helpertext)

The `helperText` method supports [Markdown](https://wordpress.com/support/markdown-quick-reference/) for the elements listed below.

```
Text::make('Title')
    ->helperText('__strong__ **strong** _italic_ *italic* `code` [link](https://example.com)')
```

### `column`

[](#column)

The `column` property is not a standard in ACF. It is used as a shorthand for setting the width of the field wrapper. You can provide a number between 0 and 100 as its value.

```
Text::make('Text')
    ->column(50) // shorthand for ->wrapper(['width' => 50])
```

Note

If you plan to use your custom fields in [block patterns](https://developer.wordpress.org/themes/patterns/), we recommend setting all fields to 100% width. The fields appear in the right-hand sidebar, which has limited space.

### `dd` and `dump`

[](#dd-and-dump)

The `dd` and `dump` methods are non-standard and not available in ACF. These methods are used for debugging.

```
Text::make('Name')
    ->dd()
    ->dump()
```

To use the `dd` and `dump` methods, you need to install `symfony/var-dumper`.

```
composer require symfony/var-dumper --dev
```

### `key`

[](#key)

The `key` method enables you to define a custom field key. The `key` should consist of alphanumeric characters and underscores, and must be prefixed with either `field_` or `layout_`.

```
Text::make('Text')
    ->key('field_123abc')
```

You can use the `key` argument to provide a custom field key in [conditional logic](#conditional-logic).

```
ConditionalLogic::where(
  name: 'color',
  operator: '==',
  value: 'red'
  key: 'field_123abc',
)
```

Important

Avoid using custom field keys unless you thoroughly understand them. The field keys are automatically generated when you use the `register_extended_field_group` function.

### `withSettings`

[](#withsettings)

The `withSettings` method overwrites any existing settings on the field when you want to add custom settings.

```
Text::make('Name')
	->withSettings(['my-new-setting' => 'value'])
	->required()
```

Another option for adding custom settings is to extend the field classes provided in the package. Please refer to the [custom fields](#custom-fields) section.

```
namespace App\Fields;

use Extended\ACF\Fields\Select as Field;

class Select extends Field
{
    public function myNewSetting(string $value): static
    {
        $this->settings['my-new-setting'] = $value;

        return $this;
    }
}
```

Macros
------

[](#macros)

Macros allow you to add custom methods to field classes at runtime. This is useful for adding reusable functionality without creating custom field classes. Register macros on the `Field` class to make them available to all field types. Use the `acf/init` hook to ensure they're available before field groups are registered.

```
use Extended\ACF\Fields\Field;
use Extended\ACF\Location;

add_action('acf/init', function () {
    Field::macro('translatable', function (Field $field): static {
        return $field->withSettings(['translatable' => true]);
    });
});

add_action('acf/include_fields', function () {
    register_extended_field_group([
        'title' => 'About',
        'fields' => [
            Text::make('Title')->translatable(),
            Textarea::make('Description')->translatable(),
        ],
        'location' => [
            Location::where('post_type', 'page'),
        ],
    ]);
});
```

If you need a macro that only applies to a specific field type, you can check the field instance:

```
use BadMethodCallException;
use Extended\ACF\Fields\Field;
use Extended\ACF\Fields\Text;

Field::macro('maxLength', function (Field $field, int $length): static {
    if (!$field instanceof Text) {
        throw new BadMethodCallException('maxLength only works on Text fields');
    }

    return $field->withSettings(['maxlength' => $length]);
});
```

Custom Fields
-------------

[](#custom-fields)

To create custom field classes, you can extend the [base field class](src/Fields/Field.php). Additionally, you can import [available setting traits](src/Fields/Settings) to add common methods like `required` and `helperText`.

```
namespace App\Fields;

use Extended\ACF\Fields\Field;
use Extended\ACF\Fields\Settings\HelperText;
use Extended\ACF\Fields\Settings\Required;

class OpenStreetMap extends Field
{
    use HelperText;
    use Required;

    protected $type = 'open_street_map';

    public function latitude(float $latitude): static
    {
        $this->settings['latitude'] = $latitude;

        return $this;
    }

    public function longitude(float $longitude): static
    {
        $this->settings['longitude'] = $longitude;

        return $this;
    }

    public function zoom(float $zoom): static
    {
        $this->settings['zoom'] = $zoom;

        return $this;
    }
}
```

When you're ready, you can import and use your field just like any other field in this library.

```
use App\Fields\OpenStreetMap;

OpenStreetMap::make('Map')
    ->latitude(56.474)
    ->longitude(11.863)
    ->zoom(10)
```

Upgrade Guide
-------------

[](#upgrade-guide)

This guide covers breaking changes for each major version. If you're upgrading from version 12 or lower, the package has been renamed — update your `composer.json` accordingly:

```
-"wordplate/acf": "^12.0",
+"vinkla/extended-acf": "^12.0"
```

**15** — PHP 8.4, renamed methods, public settings#### PHP Version

[](#php-version)

The minimum PHP version has been bumped to 8.4.

```
-"php": "^8.2"
+"php": "^8.4"
```

#### Renamed Methods

[](#renamed-methods)

The `get` method has been renamed to `toArray` on the `Field`, `Location`, and `ConditionalLogic` classes.

```
-$field->get();
+$field->toArray();

-$location->get();
+$location->toArray();

-$conditionalLogic->get();
+$conditionalLogic->toArray();
```

#### Changed Visibility

[](#changed-visibility)

The `$settings` property on field classes is now publicly readable using PHP 8.4 asymmetric visibility.

```
-protected array $settings;
+public protected(set) array $settings;
```

Changelog: [`14.6.2...15.0.0`](https://github.com/vinkla/extended-acf/compare/14.6.2...15.0.0)

**14** — PHP 8.2, renamed classes, methods, and traits#### PHP Version

[](#php-version-1)

The minimum PHP version has been bumped to 8.2.

#### Renamed Classes

[](#renamed-classes)

The `Url` class has been renamed to `URL`.

```
-use Extended\ACF\Fields\Url;
+use Extended\ACF\Fields\URL;

-Url::make('GitHub URL')
+URL::make('GitHub URL')
```

The `WysiwygEditor` class has been renamed to `WYSIWYGEditor`.

```
-use Extended\ACF\Fields\WysiwygEditor;
+use Extended\ACF\Fields\WYSIWYGEditor;

-WysiwygEditor::make('Content')
+WYSIWYGEditor::make('Content')
```

#### Renamed Methods

[](#renamed-methods-1)

The `defaultValue` method has been renamed to `default`.

```
-Text::make('Name')->defaultValue('Jeffrey Way')
+Text::make('Name')->default('Jeffrey Way')
```

The `instructions` method has been renamed to `helperText`.

```
-Text::make('Title')->instructions('Add the title text.')
+Text::make('Title')->helperText('Add the title text.')
```

The `allowMultiple` method has been renamed to `multiple`.

```
-Select::make('Colors')->allowMultiple()
+Select::make('Colors')->multiple()
```

The `allowNull` method has been renamed to `nullable`.

```
-Select::make('Features')->allowNull()
+Select::make('Features')->nullable()
```

The `characterLimit` method has been renamed to `maxLength`.

```
-Textarea::make('Description')->characterLimit(100)
+Textarea::make('Description')->maxLength(100)
```

The `pagination` method has been renamed to `paginated`.

```
-Repeater::make('Dogs')->pagination(10)
+Repeater::make('Dogs')->paginated(10)
```

The `buttonLabel` method has been renamed to `button`.

```
-Repeater::make('Cats')->buttonLabel('Add Cat')
+Repeater::make('Cats')->button('Add Cat')
```

The `weekStartsOn` method has been renamed to `firstDayOfWeek`.

```
-DatePicker::make('Date')->weekStartsOn(1)
+DatePicker::make('Date')->firstDayOfWeek(1) // or use `weekStartsOnMonday` or `weekStartsOnSunday`
```

The `prepend` method has been renamed to `prefix`.

```
-Number::make('Price')->prepend('$')
+Number::make('Price')->prefix('$')
```

The `append` method has been renamed to `suffix`.

```
-Number::make('Price')->append('€')
+Number::make('Price')->suffix('€')
```

The `mimeTypes` method has been renamed to `acceptedFileTypes`.

```
-File::make('Manual')->mimeTypes(['pdf'])
+File::make('Manual')->acceptedFileTypes(['pdf'])
```

The `enableOpacity` method has been renamed to `opacity`.

```
-ColorPicker::make('Background')->enableOpacity()
+ColorPicker::make('Background')->opacity()
```

The `delay` method has been renamed to `lazyLoad`.

```
-WysiwygEditor::make('Biography')->delay()
+WYSIWYGEditor::make('Biography')->lazyLoad()
```

The `message` method has been renamed to `body`.

```
-Message::make('Heading')->message('Text')
+Message::make('Heading')->body('Text')
```

The `insert` method has been renamed to `prependFiles`.

```
-Gallery::make('Downloads')->insert('prepend')
+Gallery::make('Downloads')->prependFiles()
```

The `returnFormat` method has been renamed to `format` on all fields.

```
-Select::make('Superhero')->returnFormat('value')
+Select::make('Superhero')->format('value')
```

#### Methods with Changed Behavior

[](#methods-with-changed-behavior)

The `stylisedUi` method has been renamed to `stylized` on the `TrueFalse` field.

```
-TrueFalse::make('Disabled')->stylisedUi(onText: 'Yes')
+TrueFalse::make('Disabled')->stylized(on: 'Yes')
```

The `stylisedUi` method has been split into `stylized` and `lazyLoad` on the `Select` field.

```
-Select::make('Friends')->stylisedUi()
+Select::make('Friends')->stylized()

-Select::make('Friends')->stylisedUi(true)
+Select::make('Friends')->lazyLoad()
```

The `mediaUpload` method has been renamed to `disableMediaUpload`.

```
-WysiwygEditor::make('Narrative')->mediaUpload(false)
+WYSIWYGEditor::make('Narrative')->disableMediaUpload()
```

The `allowArchives` method has been renamed to `disableArchives`.

```
-PageLink::make('Link')->allowArchives(false)
+PageLink::make('Link')->disableArchives()
```

The `addTerm`, `loadTerms` and `saveTerms` methods have been renamed to `create`, `load` and `save`.

```
-Taxonomy::make('Category')->addTerm()->loadTerms()->saveTerms()
+Taxonomy::make('Category')->create()->load()->save()
```

#### Renamed Arguments

[](#renamed-arguments)

The `appearance` argument `$fieldType` has been renamed to `$type`.

```
-Taxonomy::make('Cinemas')->appearance(fieldType: 'multi_select')
+Taxonomy::make('Cinemas')->appearance(type: 'multi_select')
```

The `paginated` argument `$rowsPerPage` has been renamed to `$perPage`.

```
-Repeater::make('Dogs')->paginated(rowsPerPage: 10)
+Repeater::make('Dogs')->paginated(perPage: 10)
```

#### Split Methods

[](#split-methods)

The `fileSize` method has been split into `minSize` and `maxSize`.

```
-Image::make('Background')->fileSize('400 KB', 5)
+Image::make('Background')->minSize('400 KB')->maxSize(5)
```

The `height` method has been split into `minHeight` and `maxHeight`.

```
-Gallery::make('Carousel')->height(100, 1000)
+Gallery::make('Carousel')->minHeight(100)->maxHeight(1000)
```

The `width` method has been split into `minWidth` and `maxWidth`.

```
-Image::make('Product Image')->width(100, 1000)
+Image::make('Product Image')->minWidth(100)->maxWidth(1000)
```

The `min` and `max` methods have been renamed to context-specific variants:

FieldOldNew`Gallery``min` / `max``minFiles` / `maxFiles``Relationship``min` / `max``minPosts` / `maxPosts``Repeater``min` / `max``minRows` / `maxRows``FlexibleContent``min` / `max``minLayouts` / `maxLayouts``Layout``min` / `max``minInstances` / `maxInstances````
-Gallery::make('Files')->min(1)->max(10)
+Gallery::make('Files')->minFiles(1)->maxFiles(10)

-Relationship::make('Posts')->min(1)->max(10)
+Relationship::make('Posts')->minPosts(1)->maxPosts(10)

-Repeater::make('Items')->min(1)->max(10)
+Repeater::make('Items')->minRows(1)->maxRows(10)

-FlexibleContent::make('Blocks')->min(1)->max(10)
+FlexibleContent::make('Blocks')->minLayouts(1)->maxLayouts(10)

-Layout::make('Testimonials')->min(1)->max(10)
+Layout::make('Testimonials')->minInstances(1)->maxInstances(10)
```

#### Renamed Traits

[](#renamed-traits)

If you use traits in [custom field classes](#custom-fields), update the imports:

OldNew`Instructions``HelperText``MimeTypes``FileTypes``CharacterLimit``MaxLength``Pending``Affixable``Writable``Immutable``SubFields``Fields````
-use Extended\ACF\Fields\Settings\Instructions;
+use Extended\ACF\Fields\Settings\HelperText;

-use Extended\ACF\Fields\Settings\MimeTypes;
+use Extended\ACF\Fields\Settings\FileTypes;

-use Extended\ACF\Fields\Settings\CharacterLimit;
+use Extended\ACF\Fields\Settings\MaxLength;

-use Extended\ACF\Fields\Settings\Pending;
+use Extended\ACF\Fields\Settings\Affixable;

-use Extended\ACF\Fields\Settings\Writable;
+use Extended\ACF\Fields\Settings\Immutable;

-use Extended\ACF\Fields\Settings\SubFields;
+use Extended\ACF\Fields\Settings\Fields;
```

#### Removed Traits

[](#removed-traits)

The `Message` and `ReturnFormat` traits have been removed.

```
-use Extended\ACF\Fields\Settings\Message;
-use Extended\ACF\Fields\Settings\ReturnFormat;
```

Changelog: [`13.8.0...14.0.0`](https://github.com/vinkla/extended-acf/compare/13.8.0...14.0.0)

**13** — Changed namespace#### Renamed Namespace

[](#renamed-namespace)

The namespace has been changed from `WordPlate\Acf` to `Extended\ACF`. Update all imports accordingly.

```
-use WordPlate\Acf\Fields\Text;
-use WordPlate\Acf\Fields\Number;
+use Extended\ACF\Fields\Text;
+use Extended\ACF\Fields\Number;
```

Changelog: [`12.0.3...13.0.0`](https://github.com/vinkla/extended-acf/compare/12.0.3...13.0.0)

**12** — PHP 8.0, renamed methods, removed classes#### PHP Version

[](#php-version-2)

The minimum PHP version has been bumped to 8.0.

#### Renamed

[](#renamed)

The `Attributes` namespace has been renamed to `Settings`.

```
-use Extended\ACF\Fields\Attributes\Required;
+use Extended\ACF\Fields\Settings\Required;
```

The `toArray` method has been renamed to `get` on the `Field`, `Location`, and `ConditionalLogic` classes.

```
-$field->toArray();
+$field->get();
```

The `if` method has been renamed to `where` on both the `Location` and `ConditionalLogic` classes.

```
use Extended\ACF\Location;

-Location::if('post_type', 'post')
+Location::where('post_type', 'post')
```

#### Removed

[](#removed)

The `field` and `option` helper functions have been removed.

The `setParentKey` methods have been removed.

The conditional logic comparison methods have been removed.

The configuration class and field group class have been removed.

Changelog: [`11.2.0...12.0.0`](https://github.com/vinkla/extended-acf/compare/11.2.0...12.0.0)

**11** — snake\_case names, renamed fields#### Changed Behavior

[](#changed-behavior)

The field name is now automatically formatted as snake\_case instead of kebab-case.

```
-Text::make('Organization Number') // organization-number
+Text::make('Organization Number') // organization_number
```

#### Renamed Classes

[](#renamed-classes-1)

The `Radio` field has been renamed to `RadioButton`.

```
-Radio::make('Color')
+RadioButton::make('Color')
```

The `Wysiwyg` field has been renamed to `WysiwygEditor`.

```
-Wysiwyg::make('Text')
+WysiwygEditor::make('Text')
```

Changelog: [`10.0.0...11.0.0`](https://github.com/vinkla/extended-acf/compare/10.0.0...11.0.0)

###  Health Score

72

—

ExcellentBetter than 100% of packages

Maintenance88

Actively maintained with recent releases

Popularity52

Moderate usage in the ecosystem

Community40

Growing community involvement

Maturity96

Battle-tested with a long release history

 Bus Factor1

Top contributor holds 90.4% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~45 days

Recently: every ~51 days

Total

73

Last Release

74d ago

Major Versions

12.0.3 → 13.0.02022-06-30

6.0.1 → 13.2.02022-11-28

5.1.4 → 13.6.02023-07-12

13.8.0 → 14.0.02023-11-07

14.6.2 → 15.0.02026-03-05

PHP version history (12 changes)0.1.0PHP ^7.0

4.0.0PHP ^7.1

5.0.0PHP ^7.1.3

7.0.0PHP ^7.2

8.6.0PHP ^7.3

9.0.0PHP ^7.3 || ^8.0

11.1.0PHP ^7.4 || ^8.0

12.0.0PHP ^8.0

6.0.x-devPHP ^7.1.3 || ^8.0

13.4.0PHP ^8.1

14.0.0PHP ^8.2

15.0.0PHP ^8.4

### Community

Maintainers

![](https://www.gravatar.com/avatar/63e77154439395019fb74adc3d1402bbba09ab726c74e2448968a1174c6a4415?d=identicon)[vinkla](/maintainers/vinkla)

![](https://avatars.githubusercontent.com/u/3775209?v=4)[chris andersson](/maintainers/puredazzle)[@puredazzle](https://github.com/puredazzle)

---

Top Contributors

[![vinkla](https://avatars.githubusercontent.com/u/499192?v=4)](https://github.com/vinkla "vinkla (671 commits)")[![puredazzle](https://avatars.githubusercontent.com/u/3775209?v=4)](https://github.com/puredazzle "puredazzle (16 commits)")[![fiskhandlarn](https://avatars.githubusercontent.com/u/680264?v=4)](https://github.com/fiskhandlarn "fiskhandlarn (5 commits)")[![zangab](https://avatars.githubusercontent.com/u/9076592?v=4)](https://github.com/zangab "zangab (4 commits)")[![Grafikart](https://avatars.githubusercontent.com/u/395137?v=4)](https://github.com/Grafikart "Grafikart (4 commits)")[![kaelansmith](https://avatars.githubusercontent.com/u/60372141?v=4)](https://github.com/kaelansmith "kaelansmith (4 commits)")[![edvwib](https://avatars.githubusercontent.com/u/31625202?v=4)](https://github.com/edvwib "edvwib (4 commits)")[![ernilambar](https://avatars.githubusercontent.com/u/2098823?v=4)](https://github.com/ernilambar "ernilambar (3 commits)")[![jbbouchet](https://avatars.githubusercontent.com/u/4848626?v=4)](https://github.com/jbbouchet "jbbouchet (3 commits)")[![mattkelliher](https://avatars.githubusercontent.com/u/1458275?v=4)](https://github.com/mattkelliher "mattkelliher (3 commits)")[![SolalDR](https://avatars.githubusercontent.com/u/14965864?v=4)](https://github.com/SolalDR "SolalDR (2 commits)")[![staffanmowitz](https://avatars.githubusercontent.com/u/4193622?v=4)](https://github.com/staffanmowitz "staffanmowitz (2 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (2 commits)")[![ibes](https://avatars.githubusercontent.com/u/383277?v=4)](https://github.com/ibes "ibes (2 commits)")[![drdogbot7](https://avatars.githubusercontent.com/u/1050936?v=4)](https://github.com/drdogbot7 "drdogbot7 (2 commits)")[![lukasleitsch](https://avatars.githubusercontent.com/u/3009245?v=4)](https://github.com/lukasleitsch "lukasleitsch (1 commits)")[![Bamwempan](https://avatars.githubusercontent.com/u/23477419?v=4)](https://github.com/Bamwempan "Bamwempan (1 commits)")[![dependabot-preview[bot]](https://avatars.githubusercontent.com/in/2141?v=4)](https://github.com/dependabot-preview[bot] "dependabot-preview[bot] (1 commits)")[![josephfusco](https://avatars.githubusercontent.com/u/6676674?v=4)](https://github.com/josephfusco "josephfusco (1 commits)")[![lhall-amphibee](https://avatars.githubusercontent.com/u/15910616?v=4)](https://github.com/lhall-amphibee "lhall-amphibee (1 commits)")

---

Tags

acfadvanced-custom-fieldscomposerwordpresswordpressadvancedextendedfieldsacfcustom

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/wordplate-acf/health.svg)

```
[![Health](https://phpackages.com/badges/wordplate-acf/health.svg)](https://phpackages.com/packages/wordplate-acf)
```

###  Alternatives

[vinkla/extended-acf

Register advanced custom fields with object-oriented PHP

503264.8k11](/packages/vinkla-extended-acf)[samrap/acf-fluent

A fluent interface for the Advanced Custom Fields WordPress plugin

28656.0k4](/packages/samrap-acf-fluent)[log1x/acf-editor-palette

A replica Gutenberg color picker field for Advanced Custom Fields.

100284.1k](/packages/log1x-acf-editor-palette)[hellonico/acf-country

A country field for ACF.

12193.2k](/packages/hellonico-acf-country)[log1x/acf-phone-number

A real ACF phone number field.

12072.5k](/packages/log1x-acf-phone-number)[gillesgoetsch/acf-smart-button

A simple, clean and lean ACF Field for internal and external links.

7625.5k](/packages/gillesgoetsch-acf-smart-button)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)