Awesome Open Source
Awesome Open Source

Guest Entries for Craft CMS

This plugin allows you to save guest entries from your sites front end.

Requirements

This plugin requires Craft CMS 3.4.0 or later.

Installation

You can install this plugin from the Plugin Store or with Composer.

From the Plugin Store

Go to the Plugin Store in your projects Control Panel and search for Guest Entries. Then press Install in its modal window.

With Composer

Open your terminal and run the following commands:

# go to the project directory
cd /path/to/my-project.test

# tell Composer to load the plugin
composer require craftcms/guest-entries

# tell Craft to install the plugin
php craft plugin/install guest-entries

Settings

From the plugin settings page, you can configure which sections should allow guest entry submissions, the default entry authors and statuses, and whether submissions should be validated before being accepted.

Usage

Your guest entry template can look something like this:

{% macro errorList(errors) %}
    {% if errors %}
        {{ ul(errors, {class: 'errors'}) }}
    {% endif %}
{% endmacro %}

{% set entry = entry ?? null %}

<form method="post" action="" accept-charset="UTF-8">
    {{ csrfInput() }}
    {{ actionInput('guest-entries/save') }}
    {{ hiddenInput('sectionUid', '3b78a784-8b78-4442-8774-0b33bcb11733') }}
    {{ redirectInput('success') }}

    <label for="title">Title</label>
    {{ input('text', 'title', entry ? entry.title, { id: 'title' }) }}
    {{ entry ? _self.errorList(entry.getErrors('title')) }}

    <label for="body">Body</label>
    {{ tag('textarea', {
        text: entry ? entry.body,
        id: 'body',
        name: 'fields[body]',
    }) }}
    {{ entry ? _self.errorList(entry.getErrors('body')) }}

    <button type="submit">Publish</button>
</form>

Youll need to adjust the hidden sectionUid input to point to the section youd like to post guest entries to.

If you have a redirect input, the user will get redirected to its location upon successfully saving the entry.

If there are validation errors on the entry, the page will be reloaded with an entry variable available to it. That entry variable will be a craft\elements\Entry model representing the submitted entry. You can fetch the posted values from that variable, as well as any validation errors via getErrors(), getFirstError(), or getFirstErrors(). (The name of this variable is configurable via the Entry Variable Name setting.)

Submitting via Ajax

If you submit your form via Ajax with an Accept: application/json header, a JSON response will be returned with the following keys:

  • success (boolean) Whether the entry was saved successfully
  • errors (object) All of the validation errors indexed by field name (if not saved)
  • id (string) the entrys ID (if saved)
  • title (string) the entrys title (if saved)
  • authorUsername (string) the entrys authors username (if saved)
  • dateCreated (string) the entrys creation date in ISO 8601 format (if saved)
  • dateUpdated (string) the entrys update date in ISO 8601 format (if saved)
  • postDate (string, null) the entrys post date in ISO 8601 format (if saved and enabled)
  • url (string, null) the entrys public URL (if saved, enabled, and in a section where entries have URLs)

The beforeSaveEntry event

Plugins can be notified right before a guest entry is saved using the beforeSaveEntry event. This is also an opportunity to flag the submission as spam, preventing it from getting saved:

use craft\guestentries\controllers\SaveController;
use craft\guestentries\events\SaveEvent;
use yii\base\Event;

// ...

Event::on(
    SaveController::class,
    SaveController::EVENT_BEFORE_SAVE_ENTRY,
    function(SaveEvent $e) {
        // Grab the entry
        $entry = $e->entry;

        $isSpam = // custom spam detection logic...
        
        if (!$isSpam) {
            $e->isSpam = true;
        }
    }
);

The afterSaveEntry event

Plugins can be notified right after a guest entry is saved using the afterSaveEntry event:

use craft\guestentries\controllers\SaveController;
use craft\guestentries\events\SaveEvent;
use yii\base\Event;

// ...

Event::on(
    SaveController::class,
    SaveController::EVENT_AFTER_SAVE_ENTRY,
    function(SaveEvent $e) {
        // Grab the entry
        $entry = $e->entry;
        
        // Was it flagged as spam?
        $isSpam = $e->isSpam;
    }
);

The afterError event

Plugins can be notified right after a submission is determined to be invalid using the afterError event:

use craft\guestentries\controllers\SaveController;
use craft\guestentries\events\SaveEvent;
use yii\base\Event;

// ...

Event::on(
    SaveController::class,
    SaveController::EVENT_AFTER_ERROR,
    function(SaveEvent $e) {
        // Grab the entry
        $entry = $e->entry;

        // Get any validation errors
        $errors = $entry->getErrors();
    }
);

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Php (392,389
Craftcms (598
Craft Plugin (364
Craft3 (218
Related Projects