TOFU (Template-Oriented Form Utilities)

Changelog

• v0.0.1 – Initial release.
• v0.0.2 – Arranged required PHP version to 8.1, added external services section to the readme.
• v0.0.3
  • Implemented Ajax form submission and validation with reCAPTCHA and Turnstile support.
  • Fixed recaptcha issue when embedded multiple forms on the same page.
  • Replaced validation library from wixel/gump to somnambulist/validation.
• v0.0.4
  • Added optional database recording of form submissions (saveToDatabase), encrypted at
    rest, with an admin screen to view recorded data.
  • Added Form::setTemplate() to override a form’s input/confirm/result URLs per visitor
    session, so a single registered form can be embedded on multiple pages (e.g. post
    templates); added FormConfig::$dynamicTemplate for forms configured this way.
• v0.0.5
  • The AJAX nonce endpoint (GET /wp-json/tofu/v1/forms/{key}/nonce) now also returns the
    reCAPTCHA/Turnstile site key when enabled, so cross-origin/headless clients no longer need
    to hardcode it separately from the server-side configuration.
• v0.0.6
  • Fixed: AJAX form submissions with a field literally named key could fail with a
    “form not found” error, because the REST handlers read the form key from the merged
    request parameters instead of strictly from the URL route.
• v0.0.7
  • Replaced the bundled validation library with an in-house engine. The plugin now has no
    runtime dependencies at all. Every rule name still resolves, so existing rules:
    configuration keeps working — see the upgrade notice for the behavioural differences.
  • Added: required_file as the name of the required-file rule. custom_required_file,
    its name since 0.0.3, still works and runs the same code.
  • Fixed: a full-width space (U+3000) no longer satisfies required. It is what a Japanese
    IME emits for the space bar, so a field the visitor sees as empty could pass.
  • Fixed: required now recognises an empty file input as empty.
  • Fixed: after, before, extension and uuid no longer raise a fatal error on
    ordinary input — a blank date field was enough to return a 500.
  • Fixed: uploaded_file, mimes and extension now work. They depended on a check that
    is never true in this plugin’s request flow.
  • Fixed: a file carried over to the confirm page is verified against the server’s own
    session record, so a tampered form cannot claim an upload that is not there.
  • Fixed: the session cookie is issued only when a session is actually saved. It was
    previously sent on every request, including pages with no form and the admin screens,
    which is enough to stop most full-page caches serving anything cached.
  • Fixed: the plugin never called load_plugin_textdomain(), so its bundled Japanese
    translations were not loaded and validation, reCAPTCHA and Turnstile messages rendered
    in English on Japanese sites.
  • Fixed: “reCAPTCHA token is missing.” and “Turnstile token is missing.” were the only
    bot-protection messages not passed through __(), so they stayed English even on a
    translated site.
  • Fixed: none of the recorded-submissions admin screen’s text had been extracted for
    translation since it was added in 0.0.4, so translators never received it. It is in the
    .pot now, with Japanese supplied.
  • Tested against WordPress 7.1.
• v0.1.0
  • Added: seven actions and filters, so code outside a form’s own configuration can react to
    submissions and extend validation — tofu_form_submitted,
    tofu_register_validation_rules, tofu_pre_send_mail, tofu_validation_failed,
    tofu_redirect_url, tofu_record_values and tofu_admin_page_capability. They fire for
    the redirect and AJAX flows alike. See docs/hooks/index.md.
  • Added: a named custom validation rule can now be registered site-wide, via the
    tofu_register_validation_rules action. The validator factory was previously unreachable,
    so this was not possible without editing the plugin.
  • Fixed: Form::setTemplate() no longer writes to the session, and so no longer sends a
    Set-Cookie, when a page is merely rendered. A theme calling it for each of its registered
    forms on every page load was issuing one cookie per form on every response — including
    pages with no form on them — which stops server and CDN page caches serving anything
    cached. The override is now carried to the following POST in a hidden field and persisted
    only when the visitor actually submits.
  • Fixed: at most one session cookie is issued per response. A single response can save the
    session more than once, and each save sent its own redundant Set-Cookie.
  • Fixed: database migrations now run when the plugin is updated. The plugin listened for
    upgrade_process_complete, which WordPress does not define — the hook is
    upgrader_process_complete — so migrations had only ever run on activation. A site that
    installed before a migration was added and updated since never received it; updating to
    this version applies anything outstanding. Migrations are tracked in wp_tofu_migrate and
    already-applied ones are skipped, so there is nothing to do by hand.
  • Fixed: a submission nonce is now bound to the form it was issued for. The redirect flow
    minted its nonce against a bare input/confirm action, so a nonce issued for one form
    verified against every other one; only the field name distinguished them, and a field name
    is a label the sender controls. The REST flow already did this.
  • Changed: the plugin’s own hidden field names now all use a __tofu_ prefix, and a form may
    no longer declare a field name starting with _tofu_ or __tofu_ — FormConfig throws at
    registration instead of letting the collision silently drop the form’s value. Breaking for
    AJAX/headless clients that hardcode those names; see the upgrade notice.