Edit This

Current version: 1.1.1

Edit This Documentation

Version History

1.0.0 Initial Release
1.0.1 Added session caching on security queries, and colored icons!
1.1.0 Substantially modified/improved authz caching; added support for session IDs; modified tags to require more (and different) parameters.
1.1.1 Fixed a bug causing newlines and blank pages

Installation

  1. Unzip the folder to a temporary location on your local hard drive
  2. FTP the following files from their local folders to the same locations in your EE install’s /system folder on the server:
    • /plugins/pi.edit_this.php
  3. FTP the edit_this_themes directory to the /themes directory in your EE install:

    • /themes/edit_this_themes

Usage

Note: As of 1.1.0, required tag parameters have changed.  Please review usage and adjust your tags as necessary.
This plugin will put small pencil icons in the live site, but only for users who are logged in, have an administrative session, and have permission to edit that particular resource.

All parameters are required, except “icon”.

The simplest usage is simply this tag without any enclosed text:

Entries:

{exp:edit_this:entry entry_id="{entry_id}" weblog_id="{weblog_id}" author_id="{author_id}"}

Templates:

{exp:edit_this:template template_id="42" template_group="2"}

Categories:

{exp:edit_this:category category_id="{category_id}" category_group="{category_group}"}

Gallery Images:

{exp:edit_this:image entry_id="{entry_id}"}

If you wish to use a different icon image, several different colors are provided (in the /themes/edit_this_themes/images directory). You can even put your own image there, as long as the filename ends in “_icon.gif”. Call alternate icons like so:

{exp:edit_this:template template_id="42" template_group="2" icon="blue"}

Advanced Use:

You can use the same tag, but enclose some text within it. The plugin will do the permission check, but leave the presentation of the link to you. This allows you to change the display to whatever you’d like, and you could have entire instructions or alternate content displayed by this plugin.

You can even point to a front-end editing template (stand alone editing form) using this option.

{exp:edit_this:entry entry_id="{entry_id}" weblog_id="{weblog_id}" author_id="{author_id}"}
<a href="{edit_this_url}">I can edit this</a>
{/exp:edit_this:entry}
{exp:edit_this:template template_id="42" template_group="2"}
<a href="{edit_this_url}">I can edit this</a>
{/exp:edit_this:template}
{exp:edit_this:category category_id="{category_id}" category_group="{category_group}"}
<a href="{edit_this_url}">I can edit this</a>
{/exp:edit_this:category}
{exp:edit_this:image entry_id="{entry_id}"}
<a href="{edit_this_url}">I can edit this</a>
{/exp:edit_this:image}

Image editing only applies to images in the gallery module.

Also, please note:

  • edit_this:entry only works inside entries loops.  edit_this:category only works inside category loops.  edit_this:image only works inside gallery loops.
  • You may need to set a cookie domain, or turn on cookies in the control panel, for edit_this to work.

Permissions Required

  • For entries, users must be authorized to edit entries in the specific weblog; they must have control panel access; and they must have access to the edit tab.
  • For templates, users must be authorized to edit templates in the specific template group; they must have control panel access; and they must be authorized to administer templates.
  • For categories, users must have control panel access; they must be authorized to access the admin tab; and they must be authorized to administer weblogs.
  • For gallery entries, users must have access to the gallery module; they must have control panel access; and they must have access to the modules tab.
  • For all types of content, users must have an authenticated administrative session.

Updating

Updating Edit This is easy:

  1. Download a new version from this Web site, and extract on your hard drive.
  2. Upload the new files to their appropriate locations.

Uninstallation

  1. Remove the pi.edit_this.php file from your site’s “plugins” directory.
  2. Remove the edit_this_themes directory from your site’s “themes” directory.

From the Blog

  • Click to fill out the Hop Studios Quote Request Form

Other Software



From the Blog

Subscribe to our news feed
Follow us on Twitter