trendwerk/acf-forms

Helper to use ACF forms in the front-end.

ACF Forms

Active development for this package has been discontinued., _(*1)

Helper package to use ACF forms in the front-end. What it does:, _(*2)

• Adds the ability to send notifications
• A default "Admin" notification
• Saves entries to the database
• Adds a wrapper around acf_form that does the repetitive work

This package requires Advanced Custom Fields Pro v5 to be installed., _(*3)

Quick links: Install | Usage | Options | Example, _(*4)

Install

composer require trendwerk/acf-forms

Usage

Creating and showing a form with this package consists of four parts:, _(*5)

1. Initialize package
2. Create field group
3. Register form
4. Render form

Initialize

$acfForms = new \Trendwerk\AcfForms\AcfForms();
$acfForms->init();

This code should be run when bootstrapping your theme (traditionally done via functions.php). Initialization creates the entries post type and sets up defaults form handlers and notifications., _(*6)

Create field group

Create a new field group in Advanced Custom Fields. When choosing a location where to show this field group, make sure you use Forms > Front-end is equal to Yes., _(*7)

Register form

$acfForms->register($name, $options);

Render

Rendering a form consists of two parts:, _(*8)

• Displaying the form
• Handling form data and enqueue-ing scripts (Form::head())

For example:, _(*9)

use Trendwerk\AcfForms\Form\Form;

Form::head();
...
$form = new Form($name);
$form->render();

In reality, the render method will be called somewhere inside your actual template., _(*10)

Options

Notifications

Notifications can be created by extending the Notification abstract class or the default Admin notification class., _(*11)

Example

The example below walks through all three steps of creating and showing a form, based on a field group. This example uses Twig, Timber and Sphynx., _(*12)

functions.php

$acfForms = new \Trendwerk\AcfForms\AcfForms();
$acfForms->init();

$acfForms->register('contact', [
    'acfForm'          => [
        'field_groups' => ['group_565474dcb9dd0'],
    ],
    'label'            => 'Contact',
]);

Field group keys can be found when showing the slug of the field group or in the corresponding JSON file., _(*13)

page-contact.php

<?php
// Template name: Contact

use Timber\Post;
use Trendwerk\AcfForms\Form\Form;

Form::head();

$context = Timber::get_context();
$context['post'] = new Post();
$context['form'] = new Form('contact');

Timber::render('page-contact.twig', $context);

page-contact.twig

{% extends 'base.twig' %}

{% block content %}



    {{ post.title }}
  



  {{ post.content }}

  {{ form.render() }}
{% endblock %}