Skip to content

Commit

Permalink
update readmes & changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
joshuadavidnelson committed Dec 26, 2023
1 parent 72f71d5 commit 440e627
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 6 deletions.
11 changes: 6 additions & 5 deletions changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
- Add `aps_archived_label_string` filter to modify the "Archived" string used for the label.
- Add `aps_title_separator` and `aps_title_label` to filter the post title prefix and separator, defaults to 'Archived' with a `:` separator. Disable the title prefix entirely by using `add_filter( 'aps_title_prefix', '__return_false' );` in your functions.php file or custom plugin file. Closes #21
- Added `aps_title_label_before` filter, defaults to `true` - pass `false` to have the label appear after the title instead of before it. This change along with the label string filter above closes #31
- Add PHPUnit tests & github actions.
- Update some comments and documentation, readmes, etc

## 0.3.8 - December 15, 2023
Expand All @@ -14,11 +15,11 @@ Ownership of this plugin is being transferred to [Joshua David Nelson](https://g

This update includes:
- Tested up to WordPress 6.4.2
- Added minimum PHP of 7.4
- Bumped minimum WordPress to 5.3
- Added Github actions for deployment to WP repo
- Updated contributors in readmes
- Added PHPStan and PHPCS Github actions
- Add minimum PHP of 7.4
- Bump minimum WordPress to 5.3
- Add Github actions for deployment to WP repo
- Update contributors in readmes
- Add PHPStan and PHPCS Github actions

## 0.3.7 - December 23, 2016
* Tweak: Indicate support for WordPress 4.7.
Expand Down
13 changes: 12 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ This is what makes the Archived post status handy. You can unpublish content wit

### Where are the options for this plugin?

This plugin does not have a settings page. However, there are numerous hooks available in the plugin so you can customize default behaviors. Many of those hooks are listed below in this FAQ
This plugin does not have a settings page. However, there are numerous hooks available in the plugin so you can customize default behaviors. Many of those hooks are listed below in this FAQ.

### Why are Archived posts appearing on the front-end?
This is most likely because you are viewing your site while being logged in as an Editor or Administrator.
Expand Down Expand Up @@ -112,6 +112,17 @@ function my_aps_excluded_post_types( $post_types ) {
add_filter( 'aps_excluded_post_types', 'my_aps_excluded_post_types' );
```

### My archived posts have disappeared when I deactivate the plugin!

Don't worry, your content is not __gone__ it's just __inaccessible__. Unfortunately, using a custom post status like `archive` is only going to work while the plugin is active.

If you have archived content and deativate or delete this plugin, that content will disappear from __view__. You're content is in the database - WordPress just no longer recognizes the `post_status` because this plugin is not there to set this post status up.

If you no longer need the plugin but want to retain your archived content:
1. (Re)activate this plugin
2. Switch all the archived posts/pages/cpts to a native post status, like 'draft' or 'publish'
3. THEN deactivate/delete the plugin.


## Screenshots

Expand Down
34 changes: 34 additions & 0 deletions readme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,17 @@ function my_aps_excluded_post_types( $post_types ) {
add_filter( 'aps_excluded_post_types', 'my_aps_excluded_post_types' );
</pre>

= My archived posts have disappeared when I deactivate the plugin! =

Don't worry, your content is not __gone__ it's just __inaccessible__. Unfortunately, using a custom post status like `archive` is only going to work while the plugin is active.

If you have archived content and deativate or delete this plugin, that content will disappear from __view__. You're content is in the database - WordPress just no longer recognizes the `post_status` because this plugin is not there to set this post status up.

If you no longer need the plugin but want to retain your archived content:
1. (Re)activate this plugin
2. Switch all the archived posts/pages/cpts to a native post status, like 'draft' or 'publish'
3. Then deactivate/delete the plugin.

= Help! I need support =

Please reach out on the Github Issues or in the WordPress support forums.
Expand All @@ -128,6 +139,14 @@ Please reach out on the Github Issues or in the WordPress support forums.

== Changelog ==

= 0.3.9 =
- Fix deprecated php warning on `filter_input`, using native WP functions for escaping & getting query var.
- Add `aps_archived_label_string` filter to modify the "Archived" string used for the label.
- Add `aps_title_separator` and `aps_title_label` to filter the post title prefix and separator, defaults to 'Archived' with a `:` separator. Disable the title prefix entirely by using `add_filter( 'aps_title_prefix', '__return_false' );` in your functions.php file or custom plugin file. Closes #21
- Added `aps_title_label_before` filter, defaults to `true` - pass `false` to have the label appear after the title instead of before it. This change along with the label string filter above closes #31
- Add PHPUnit tests & github actions.
- Update some comments and documentation, readmes, etc

= 0.3.8 - December 15, 2023 =

Ownership of this plugin is being transferred to [Joshua David Nelson](https://profiles.wordpress.org/joshuadnelson/). A huge thank you to @fjarrett for his work on this plugin to this point. More info to come soon, keep an eye on the [Github Repository](https://github.com/joshuadavidnelson/archived-post-status/)!
Expand Down Expand Up @@ -206,3 +225,18 @@ Props [fjarrett](https://github.com/fjarrett), [pollyplummer](https://github.com
* Initial release.

Props [fjarrett](https://github.com/fjarrett)

== Upgrade Notice ==

= 0.3.9 =

- Fix deprecated php warning on `filter_input`.
- Add filters for label and title string & separator, see changelog.

= 0.3.8 =

- Tested up to WordPress 6.4.2
- Add minimum PHP of 7.4
- Bump minimum WordPress to 5.3
- Add Github actions for deployment & coding standards
- Update contributors in readmes

0 comments on commit 440e627

Please sign in to comment.