Software

Hop Edit This

Current Version: 4.1.0
  • Installation for EE 3/4/5

    1. Unzip the folder to a temporary location on your local hard drive.
    2. FTP the files from their local folders to the same locations in your EE install’s /system/user/addons/ folder on the server.
    3. Navigate to Add-ons in your EE control panel and install the add-on. That’s it!

  • Installation for EE 2

    1. Unzip the main file to a temporary location on your local hard drive.
    2. FTP the files from their local folders to the same locations in your EE install’s /system/expressionengine/third_party folder on the server.
    3. FTP the themes/hop_edit_this/ directory to the /themes/third_party/ directory in your EE install: /themes/third_party/hop_edit_this/
  • Installation for EE 1

    The Hop Edit This zip file contains an earlier version of EditThis for people still using EE 1.x.

    1. Unzip the folder to a temporary location on your local hard drive.
    2. Unzip the EditThis 1.1.1.zip file.
    3. Open the EditThis 1.1.1 directory. FTP the pi.edit_this.php file to your EE install’s /system/plugins/ folder on the server.
    4. FTP the /edit_this_themes/ directory to the /themes/ directory in your EE 1.x install.
  • Usage

    This plugin puts little pencils, visible on the live site, that are helpful links to directly edit entries, categories and templates. It does this only for users who are:

    • logged in
    • have an administrative session
    • and have permission to edit that particular resource.

    For EE 1/2 All parameters are required, except for ‘icon’
    For EE 3+ All parameters are required, except for ‘icon’, ‘channel_id’, ‘author_id’.

    The simplest usage is simply this tag without any enclosed text. Try placing this tag inside an exp:channel:entries tag:

    {exp:hop_edit_this:entry entry_id="{entry_id}" channel_id="{channel_id}" author_id="{author_id}"}

    * Using weblog_id for channel_id will also work.

    That tag will return an image and link that looks like this:

    <a href="URL_TO_CP" title="Edit this" target="_blank"><img src="/themes/third_party/hop_edit_this/images/default_icon.gif"
     height="14" width="14" class="hop_edit_this" style="padding-left: 4px" alt="Edit this" align="top" border="0" /></a>

    You can override styles on the edit pencil using the .hop_edit_this class.

  • Single Tags

    Entries

    {exp:hop_edit_this:entry entry_id="{entry_id}" channel_id="{channel_id}" author_id="{author_id}"}

    Notes: Using weblog_id for channel_id will also work. If you omit channel_id and author_id, the plugin will do an extra database call to fetch those, but it’s more efficient to include them in the tag.

    Templates

    {exp:hop_edit_this:template template_id="42" template_group="2"}
    {exp:hop_edit_this:template template_id="{template_id}" template_group="{template_group_id}"}

    Notes: At some point in EE4 or EE5, you became able to fetch the id and group_id of the current template, which makes this tag a lot more useful. In earlier versions of EE you will need to hard code it or fetch it some creative way such as with PHP.

    Categories

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

    Gallery Images (1.x only)

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

    If you wish to use a different icon image, several different colors are provided (in the /themes/hop_edit_this/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:hop_edit_this:template template_id="42" template_group="2" icon="blue"}
  • Tag Pairs

    You can use the edit_this tag as a tag pair if you enclose 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. This means you can have entire instructions or alternate content displayed by this plugin.

    For example, you can point to a front-end editing template (stand alone editing form) using this option.  Or you could make the link be straight text, not the pencil image.

    {exp:hop_edit_this:entry entry_id="{entry_id}" channel_id="{channel_id}" author_id="{author_id}"}
    <a href="{hop_edit_this_url}">I can edit this</a>
    {/exp:hop_edit_this:entry}
  • Permissions Required

    • For entries, users must be authorized to edit entries in the specific channel 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 channels.
    • 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.

    Also, please note that for most usefulness, you may want to set the CP login to Cookie Only, so that you stay logged in more often.  You may also need to set the cookie domain properly, or turn on cookies in the control panel, for hop_edit_this to work properly.

  • Updating

    Updating is easy:

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

  • Uninstalling

    1. Navigate to the Add-Ons/Modules tab in your EE control panel and uninstall the module.
    2. Remove the add-on directory from your EE system folder on the server.

    Also:

    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.
  • Version History

    4.1.0
    Make author_id and channel_id optional parameters for hop_edit_this:entry, create function to lookup values based on entry_id
    Update docs to match new optional/required parameters in hop_edit_this:entry
    4.0.3
    Cleanup template tag parameters verification
    4.0.2
    Fix template tag cache key
    4.0.1
    Fix EE2 group name parameter
    Fix hop_edit_this_url generation issues
    4.0.0
    Rename addon from "Edit This" to "Hop Edit This"
    3.0.0
    Updated for EE 3
    2.4
    Fixed issue with EE 2.9
    2.3
    Generates new control panel URLs for EE 2.8, and yet is also backwards compatible with EE 2.7 and lower.
    2.2
    Correctly deals with fingerprints instead of session IDs
    2.1
    Added an "edit_this" class to the icon for easier styling
    2.0.1
    Switched to using the third_party themes directory
    2.0.0
    Initial release for EE 2.x
    1.1.1
    Fixed a bug causing newlines and blank pages
    1.1.0
    Substantially modified/improved authz caching added support for session IDs modified tags to require more (and different) parameters.
    1.0.1
    Added session caching on security queries, and colored icons!
    1.0.0
    Initial Release

Have a Project for Us?

Get in Touch