tombroucke/acf-objects

Make ACF's get_field return objects with easy-to-use methods

3.1.2 2022-10-27 14:10 UTC

README

Installation

composer require tombroucke/acf-objects

Usage

  • In sage 10, Acorn should be able to locate src/AcfObjectsServiceProvider.php. If it doesn't, you should add this provider to the providers array in /config/app.php:
Otomaties\AcfObjects\AcfObjectsServiceProvider::class
  • To use this library without Acorn, use this snippet:
add_filter('acf/format_value', function ($value, $post_id, $field) {
    $value = \Otomaties\AcfObjects\Acf::findClassByFieldType($value, $post_id, $field);
    return $value;
}, 99, 3);

Examples

Wherever you want to use ACF Objects, import the Otomaties\AcfObjects\Acf class:

<?php use Otomaties\AcfObjects\Acf; ?>

Test if field has value

<?php if(Acf::getField('fieldname')->isSet()): ?>
<?php endif; ?>

Fields with array access (Gallery, Repeater, Flexible Content)

<?php if(!Acf::getField('fieldname')->isEmpy()): ?>
<?php endif; ?>

Datepicker

<?php echo Acf::getField('date')->format('d/m/Y'); ?>

File

<?php echo Acf::getField('file')->url(); ?>
<?php echo Acf::getField('file')->title(); ?>
<?php echo Acf::getField('file')->filesize(); ?>

Gallery

<ul>
  <?php foreach (Acf::getField('gallery') as $image): ?>
    <li><?php echo $image->attributes(['class' => 'd-none'])->image(); ?></li>
  <?php endforeach; ?>
</ul>

Gallery array access

<?php echo Acf::getField('gallery')[1]->image(); ?>

Google maps

<?php echo Acf::getField('google_map')->address(); ?>
<?php echo Acf::getField('google_map')->lat(); ?>
<?php echo Acf::getField('google_map')->lat(); ?>
...

Group

<?php echo Acf::getField('group')->get('text'); ?>

Image

<?php echo Acf::getField('image')->url('medium'); ?> 

Image tag

<?php echo Acf::getField('image')->image('medium'); ?>

Image tag with attributes, wrapped with link

<a href="<?php echo Acf::getField('image')->url('full'); ?>">
  <?php echo Acf::getField('image')->attributes(['class' => 'w-100'])->image('thumbnail'); ?>
</a>

Image with default image from media library, media ID 48

<?php echo Acf::getField('image')->default(48, 'thumbnail')->image('thumbnail'); ?>

Image with default image from url

<?php echo Acf::getField('image')->default('https://picsum.photos/150/150')->image('thumbnail'); ?>

Link

<?php echo Acf::getField('link')->link(); // Will output an a-tag with href, target & title ?>
<?php echo Acf::getField('link')->attributes(['class' => 'btn btn-primary','data-foo' => 'bar'])->link(); ?>
<a href="<?php echo Acf::getField('link')->url(); ?>" target="<?php echo Acf::getField('link')->target(); ?>">
    <?php echo Acf::getField('link')->title(); ?>
</a>

Repeater

<table class="table">
  <?php foreach (Acf::getField('repeater') as $key => $row): ?>
    <tr>
      <td><?php echo $key; ?></td>
      <td><?php echo $row->get('text'); ?></td>
      <td><?php echo $row->get('image')->image('thumbnail'); ?></td>
    </tr>
  <?php endforeach; ?>
</table>

Repeater array access

<?php if (isset(Acf::getField('repeater')[0])): ?>
  <?php echo Acf::getField('repeater')[0]->get('text'); ?>
<?php endif; ?>

Text

<?php echo Acf::getField('text'); ?>
<?php echo Acf::getField('text')->default('Default text'); ?>

Text from other post

<?php echo Acf::getField('text', 51); ?>

ACF Fluent

During development of this package, I stumbled upon ACF Fluent by samrap, which works great. The biggest difference between ACF Fluent and this package, is the ability to easily display images: Acf::getField('image')->image('thumbnail') and a more intuitive way to iterate over repeater & gallery fields.