Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/10up/wp-safe-edit
ARCHIVED: Safely edit published posts behind the scenes without affecting the live site.
https://github.com/10up/wp-safe-edit
archived
Last synced: 3 months ago
JSON representation
ARCHIVED: Safely edit published posts behind the scenes without affecting the live site.
- Host: GitHub
- URL: https://github.com/10up/wp-safe-edit
- Owner: 10up
- Archived: true
- Created: 2017-09-22T20:53:49.000Z (about 7 years ago)
- Default Branch: develop
- Last Pushed: 2024-05-02T18:35:53.000Z (7 months ago)
- Last Synced: 2024-05-03T05:03:48.373Z (6 months ago)
- Topics: archived
- Language: PHP
- Homepage:
- Size: 1.41 MB
- Stars: 18
- Watchers: 55
- Forks: 4
- Open Issues: 18
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# WP Safe Edit
> Safely edit published posts behind the scenes without affecting the live site. You can save your changes as a draft and publish them when ready, so you don't have to finish your updates in one sitting. This gives editors the opportunity to collaborate on changes or get approval before publishing.
[](#support-level) [](https://github.com/10up/wp-safe-edit/blob/5d7cf0c421d6fdbeb98e3dd54ccb3d41e6d3d4d2/composer.json#L8)
> [!CAUTION]
> As of 12 April 2024, this project is archived and no longer being actively maintained.
## Requirements
* **WordPress >= 4.5** due to the use of `get_post_types_by_support()`
* **PHP >=5.4**
## Installation
1. Download and activate the plugin in WordPress.
2. Draft functionality is available for posts and pages by default. You can register support for custom post types using a filter:
```php
add_filter( 'safe_edit_supported_post_types', function( $post_types ) {
// Add 'book' post type to array of supported post types.
$post_types[] = 'book';
return $post_types;
} );
```
## Usage
1. When this plugin is installed, a **"Save as Draft"** button [Fig. 1] will be available for posts and pages as well as the post types you registered support for. Pressing this button will create a draft copy of the post where you can stage your changes. All post meta and taxonomy terms associated with the post will be included.
2. When editing a draft, it functions like any other post so you can do the following:
* **Save Changes as a Draft:** Changes saved as a draft will not be reflected on the live site until you publish them.
* **Preview Changes:** Preview your changes at any time by pressing the **"Preview"** button.
* **Trash Changes:** If you change your mind, you can trash your updates by pressing the **"Move to Trash"** link.
3. Once you're happy with your changes, publish them by pressing the **"Publish Changes"** button [Fig. 2]. The post you created the draft from will be updated with your changes and reflected on the live site.
## Viewing Previous Drafts
You can view the most recent drafts created for a post using the **"Archived Draft Revisions"** meta box [Fig. 3]. Unlike WordPress revisions, all content, terms, and meta data are retained so you can see what the draft looked like when it was published.
## Caveats & Limitations
1. This plugin isn't compatible with post types using Gutenberg yet.
2. You cannot edit a post in the dashboard if an open draft exists for it because the changes would be overwritten when the draft is published; a lockout message is shown if you try [Fig. 4]. **Note:** It's still possible to edit the post through an API or code, so consider that before enabling support. A planned improvement is to interrupt the publish draft process when the source post has been modified since the draft was created.
3. If a post type contains meta boxes that save data behind the scenes using AJAX, you may need to hook into the publish draft process to make adjustments. Consider the following scenario:
1. You create a draft of a post.
2. On the draft, you use a meta box that creates an associated post in the background using AJAX. The associated post references the draft's post ID.
3. You publish the draft.
4. The source post has been updated with the changes from the draft, but the associated post you created still references the draft's post ID. To resolve this, adjustments to the associated post needs to be made during the draft publishing process using either the `safe_edit_before_merge_post` or `safe_edit_after_merge_post` action.
4. You cannot change a post's URL slug using a draft because drafts are always published back to the source post retaining the original URL.
## Roadmap
Some of the planned improvements are listed below:
- Compatibility with Gutenberg.
- Interrupt the publish draft process when the source post has been modified since the draft was created.
- Break up some of the more complex draft/merge functions.
- Complete unit tests.
- Show more than the last 10 archived drafts.
## Support Level
**Archived:** This project is no longer maintained by 10up. We are no longer responding to Issues or Pull Requests unless they relate to security concerns. We encourage interested developers to fork this project and make it their own!
## Like what you see?
