Select your language

Obix Front End Edit Helper

This package tries to enhance front end article editing, i.e. the creation and modification of articles on the site as opposed to in the administrator.

In het Nederlands: README.nl-NL.md.

Raison d'être

There are several reasons why one might consider to offer clients the ability to maintain content in the front end of the website:

  • Joomla administration is comprehensive. Too comprehensive for some.
  • It is not always desirable to give users access to the administrator area and no easy feat to adjust the administrator UI to a users capabilities and access rights.

Minimal requirements

  • Joomla! 6.2
  • PHP 8.3

On a site still running Joomla 4 or 5, switch the plugin off, upgrade the CMS, and install 3.0.0 over it. Your settings survive that. UPGRADE.md walks it through.

Upgrading

Coming from an older release, read UPGRADE.md first — it sits beside this file, in the package and on disk at plugins/system/frontendedit/. It describes the whole path — 2.3.3 → Joomla 6 → 3.0.0 — why each step exists, what the installer changes on its own and what authors notice. In short:

  • Switch the plugin off before upgrading the CMS. An older release stops the page on Joomla 6, and switching off keeps its settings where uninstalling would take them with it.
  • Switch it back on after installing 3.0.0. An update never enables a plugin.
  • The extension and the CMS never move in the same step.
  • 3.0.0 carries your settings across by itself, and moves every menu item onto the layout that ships.
  • A template override of the edit layout stops being used and has to be ported by hand. The installer names the file; HOW-TO-OVERRIDES.md is the guide.

Known conflict: the "Button - Translator" editor plugin

Does the front-end edit form give a 500 error after the upgrade to Joomla 5 or 6? Switch the editors-xtd/translator plugin off under System → Plugins, or update it to a version that supports Joomla 5. That plugin is not part of this package.

The error in the log is:

Call to undefined method Joomla\CMS\Object\CMSObject::getButtonName()
  layouts/joomla/editors/buttons/button.php:21

Every page with an editor field runs into it, the administrator's own article form included. The same goes for any other editor-button plugin that has not been updated for Joomla 5.

After an install or update this package lists the enabled editor-button plugins that are not part of Joomla. That is a list of suspects, not a diagnosis: whether one of them is out of date only shows when it runs.

Installation and configuration

Installation is the same as for any other Joomla package. If it is installed for the first time, as opposed to upgraded, plugins are supposed to be activated automatically. Doesn't do any harm to check though :)

The package installs one extension: a system plugin. Up to 2.x it installed a support library beside it; that is now part of the plugin, and the installer removes the old library from sites that still carry one.

The package ships English and Dutch language files, so on a Dutch administrator the tabs and settings named below appear under their Dutch names. README.nl-NL.md lists both.

Configuration

The plugin itself has a few settings:

  • Hide edit links: When front end editing is enabled, is not always desirable to show the regular Edit link on pages other than the front-end edit page. This option allows removal of those links.
  • Remove YOOtheme assets: For some mysterious reason, YOOtheme assets (CSS and JavaScript) are loaded on none YOOtheme pages. This options allows removal of those assets.

Description

The package, or more precisely the plugin, adds tabs to the regular menu item edit pages of article related ( com_content), multi item menu items (Category List, Category Blog): Front End Edit Options and Front End Edit Fields.

Menu items that carry front end edit settings are marked in the menu items list with a badge — blue when front end editing is on, grey when settings are present but it is switched off. The list is a core screen, so the badge is added from JavaScript rather than a template override: if a future Joomla changes that table the badge simply does not appear, and nothing else is affected.

Front End Edit Options

The general settings of the menu item.

Enabled
Switches front-end editing on for this page. It also shows the Front End Edit Fields tab and the settings below. Default: No.
Edit layout
The layout that renders the front-end edit form. It also decides which field settings are read, so check it first when a setting has no effect. Default: front-end-edit-auto, under ---From Front End Edit---.
Keep that layout. It is the only one that reads the Front End Edit Fields tab; with Joomla's own Create layout, hiding a field does nothing.
Layouts of your own appear under ---From template name Template---. Put the file in .../templates/<template>/html/com_content/form, give it a name other than edit.php and use no underscores. Start from a copy of layouts/front-end-edit-auto.php. A copy of the 2.x layout empties hidden fields on every save; HOW-TO-OVERRIDES.md is the porting guide.
Show fields nobody configured
What happens to a field that has no switch on the Front End Edit Fields tab, such as one Joomla or a plugin added after this menu item was configured. Yes shows it to the author. Default: Yes, except on menu items the installer moved off the 2.x layout.
Offer the article display options
Offers the per-article display options — layout, whether the title, category, author and dates are shown, where the info block and the links sit — on the Front End Edit Fields tab, where you show or hide each one like any other field. Default: No.
They appear on that tab as soon as you switch this on; no save needed. Switch it off and they disappear again, with their settings kept.
Force menu item
Makes Edit links point at this menu item. Without it Joomla takes the first Category List or Category Blog item in the menus, so an author who closes the edit screen lands on the wrong page. Default: Yes.
Show own articles only
Limits the list to articles the logged-in user created. It governs the list and nothing else: Edit and Edit Own on the category decide who may edit which article. Default: No.
Add Trash button
Adds a Trash button beside Save and Cancel, which moves the article to the trash as the administrator's button does. It does not delete the article; emptying the trash stays work for an administrator. Only an author with Edit State on the article sees the button. Default: No.
Hide YOOtheme builder button
Hides the "YOOtheme Builder" button under the article text field. The setting only appears when YOOtheme is installed and is the active template. Default: Yes.
Copy to menu items
Copies every front-end edit setting of this menu item to the menu items you select.

Joomla's permissions decide what may be saved, and they are checked after everything these two tabs do. A field the permissions withhold from an author — Status, Featured, the publishing dates for anyone without Edit State — is not shown to them and not accepted from them. See Hiding a field is not a permission.

Front End Edit Fields

Decides which fields an author sees on the front-end edit form, and what happens to the ones they do not see. Only visible when Enabled on the Front End Edit Options tab is set to Yes.

One row per field, in the groups the edit form uses: Content, Intro image, Full article image, Images, Links, Publishing, Metadata, Associations, Schema, Editor configuration, the groups your custom fields are in, and Other for what fits nowhere. Each row shows the field's label, its technical name (images.image_intro), a Yes/No switch and a box for the value to submit when the switch is off.

What a field set to No does:

  • On an existing article it keeps the value the article already has. Hiding a field does not empty it.
  • On a new article it gets the value in the box beside it, or nothing when that box is empty.
  • A composite value — from a media custom field, for instance — cannot be typed in and keeps what it was set to. The box says so.

A field with no switch at all follows Show fields nobody configured on the Options tab.

The list is read from the article edit form at the moment you open the tab. So custom fields, the editor configuration and anything a future Joomla or plugin adds are in it. Two kinds of field are not in the list and cannot be configured:

  • Fields the form itself keeps hidden — ids, tokens, anything without a label. They carry values the save needs and are always submitted.
  • The article id, the asset id, the created date, the author column and the version history. They are not on the author's form either.

Robots, Meta author, Meta rights and the three link targets come from the administrator's article form, so their settings on this tab apply. Every other field is Joomla's site version.

A setting for a field this tab does not show — a plugin switched off, a custom field removed, the article display options not offered — is kept and returns with the field.

Three fields need a decision from you:

Title
Joomla requires it. Existing articles keep their own title, but a new article gets what stands in the box beside it — and with an empty box it will not save.
Category
Hidden, the category in the box is where new articles are filed.
Status
Hidden, the status in the box is what new articles get, as far as the author may set it. com_content disables this field for anyone without Edit State, and a disabled field is not submitted, so for those authors Joomla's own default applies and the box does nothing. Give the group Edit State when that default matters, and leave the box empty when the author must not set the status. The front-end edit log names every field whose configured default was dropped this way.

Your own unpublished articles are in the list

On a menu item with front-end editing on, the list shows all published articles plus the logged-in user's own articles, whatever state those are in. Core Joomla shows published articles only, which is why an author without publishing rights sees a submitted article disappear.

What it does not do:

  • It shows nobody else's unpublished articles. The condition names the current user, so another author's draft does not match it.
  • It grants no editing right. Edit Own and Edit on the category still decide what an author may open.
  • It grants no publishing right. com_content disables Status for anyone without Edit State and drops the value before saving, even when the field is added to the page by hand.

There is no setting for this. To get the core behaviour back — submissions vanishing until someone approves them — switch front-end editing off for that menu item, or point authors at a menu item that does not have it.

Hiding a field is not a permission

The Fields tab decides what an author sees, not what they may save. A hidden field is left out of the form, but it is not refused when it arrives. Somebody who edits the page in their browser and posts a field back gets whatever Joomla's permissions allow them, decided from core.edit, core.edit.own and core.edit.state on the category.

Joomla refuses state, featured, publish_up, publish_down and ordering from anyone without Edit State, so hiding those genuinely holds for such an author. It refuses none of access, alias, language, metadesc, metakey and the custom fields from anyone who may edit the article at all, so hiding those is presentation and nothing more.

Do not use Status with a default of Unpublished to moderate front-end submissions. Under the permissions the Usage section recommends the author has Edit State, so Joomla accepts the field and the moderation can be walked around. Take Edit State away from the group instead, and Joomla enforces it.

Usage

  • Create a user group for the users who may manage articles in the front end.
  • Add users to the group.
  • Create a category those users may add articles to.
  • Set the permissions on that category to:
    • Create: Allowed
    • Delete: Allowed
    • Edit: Inherited (Not Allowed)
    • Edit State: Allowed
    • Edit Own: Allowed
  • Create a menu item and set its Menu Item Type to Category List or Category Blog.
  • On the Front End Edit Options tab, set Enabled to Yes and go through the other settings. Edit layout already points at the layout that ships.
  • On the Front End Edit Fields tab, switch off the fields the author must not see and fill in a value for the fields that take one.
  • Open the front-end edit form once before you hand it to an author. A field nobody configured is shown, so custom fields are on the form until you switch them off.

Edit State: Allowed is what lets an author publish and unpublish their own articles, which is what most sites want. It also means Joomla accepts a status from that author, whether or not the Fields tab shows them the control. Leave this permission out when front-end submissions have to be moderated.

Workflows

With workflows switched on in com_content, an article saved from the front end takes part in the workflow. Joomla gives it a stage on save and offers the transition field in the edit form, as it does in the administrator.

The Transition switch on the Front End Edit Fields tab decides whether front-end authors see that field. With workflows off the field does not exist and the switch does nothing.

Not supported:

  • Stage-dependent permissions. Which fields an author may edit does not change with the stage the article is in.
  • Restricting which transitions a front-end author may run. They are offered whatever the workflow offers their account, exactly as in the administrator.