forked from joshuadavidnelson/archived-post-status
-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.txt
167 lines (105 loc) · 6.78 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
=== Archived Post Status ===
Contributors: fjarrett
Tags: admin, posts, pages, status, workflow
Requires at least: 3.6
Tested up to: 4.3
Stable tag: 0.3.3
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Allows posts and pages to be archived so you can unpublish content without having to trash it.
== Description ==
**Did you find this plugin helpful? Please consider [leaving a 5-star review](https://wordpress.org/support/view/plugin-reviews/archived-post-status).**
This plugin allows you to archive your WordPress content similar to the way you archive your e-mail.
* Makes a new post status available in the dropdown called Archived
* Unpublish your posts and pages without having to trash them
* Compatible with posts, pages and custom post types
* Ideal for sites where certain kinds of content is not meant to be evergreen
**Languages supported:**
* English
* Deutsch
* Español
* Français
* Nederlands
* Português
* Русский
**Development of this plugin is done [on GitHub](https://github.com/fjarrett/archived-post-status). Pull requests welcome. Please see [issues reported](https://github.com/fjarrett/archived-post-status/issues) there before going to the plugin forum.**
== Frequently Asked Questions ==
= Where are the options for this plugin? =
This plugin does not have a settings page. Simply put, I don't like bloating my plugins with a bunch of options.
Instead, I try to develop functionality using the 80/20 principle so that for 80% of use cases you all you need to do is activate the plugin and it "just works".
For the other 20% of you who want things to behave differently 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.
By default, any user with the [`read_private_posts`](http://codex.wordpress.org/Roles_and_Capabilities#read_private_posts) capability will see Archived posts appear on the front-end of your site.
You can change the default read capability by adding this hook to your theme's `functions.php` file or as an [MU plugin](http://codex.wordpress.org/Must_Use_Plugins):
<pre lang="php">
function my_aps_default_read_capability( $capability ) {
$capability = 'read';
return $capability;
}
add_filter( 'aps_default_read_capability', 'my_aps_default_read_capability' );
</pre>
= Can I make Archived posts appear on the front-end for all users? =
Yes, simply add these hooks to your theme's `functions.php` file or as an [MU plugin](http://codex.wordpress.org/Must_Use_Plugins):
<pre lang="php">
add_filter( 'aps_status_arg_public', '__return_true' );
add_filter( 'aps_status_arg_private', '__return_false' );
add_filter( 'aps_status_arg_exclude_from_search', '__return_false' );
</pre>
= Can I make Archived posts hidden from the "All" list in the WP Admin, similar to Trashed posts? =
Yes, simply add these hooks to your theme's `functions.php` file or as an [MU plugin](http://codex.wordpress.org/Must_Use_Plugins):
<pre lang="php">
add_filter( 'aps_status_arg_public', '__return_false' );
add_filter( 'aps_status_arg_private', '__return_false' );
add_filter( 'aps_status_arg_show_in_admin_all_list', '__return_false' );
</pre>
Please note that there is a [bug in core](https://core.trac.wordpress.org/ticket/24415) that requires public and private to be set to false in order for the `aps_status_arg_show_in_admin_all_list` to also be false. There are many bugs in core surrounding registering custom post statuses, so if something doesn't work the way you want on the first try be prepared to do some digging through trac :-)
= Can I exclude the Archived status from appearing on certain post types? =
Yes, simply add this hook to your theme's `functions.php` file or as an [MU plugin](http://codex.wordpress.org/Must_Use_Plugins):
<pre lang="php">
function my_aps_excluded_post_types( $post_types ) {
$post_types[] = 'my_custom_post_type';
return $post_types;
}
add_filter( 'aps_excluded_post_types', 'my_aps_excluded_post_types' );
</pre>
= Isn't this the same as using the Draft or Private statuses? =
Actually, no, they are not the same thing.
The Draft status is a "pre-published" status that is reserved for content that is still being worked on. You can still make changes to content marked as Draft, and you can preview your changes.
The Private status is a special kind of published status. It means the content is published, but only certain logged-in users can view it.
The Archived post status, on the other hand, is meant to be a "post-published" status. Once a post has been set to Archived it can no longer be edited or viewed.
Of course, you can always change the status back to Draft or Publish if you want to be able to edit its content again.
= Can't I just trash old content I don't want anymore? =
Yes, there is nothing wong with trashing old content. And the behavior of the Archived status is very similar to that of trashing.
However, WordPress automatically purges trashed posts every 7 days (by default).
This is what makes the Archived post status handy. You can unpublish content without having to delete it forever.
== Screenshots ==
1. Post list table screen
2. Quick Edit mode
3. Publish metabox controls
== Changelog ==
= 0.3.3 - September 12, 2015 =
* New: Indicate support for WordPress 4.3
Props [fjarrett](https://github.com/fjarrett)
= 0.3.2 - March 25, 2015 =
* Fix: Non-object warnings when `$post` is null ([#6](https://github.com/fjarrett/archived-post-status/issues/6))
Props [fjarrett](https://github.com/fjarrett), [stevethemechanic](https://github.com/stevethemechanic), [edwin-yard](https://profiles.wordpress.org/edwin-yard/)
= 0.3.1 - January 27, 2015 =
* New: Added language support for Nederlands
* Tweak: Refreshed existing language files
* Fix: Missing argument warning on `the_title` filter
Props [fjarrett](https://github.com/fjarrett), [RavanH](https://github.com/RavanH), [htrex](https://profiles.wordpress.org/htrex/)
= 0.3.0 - January 26, 2015 =
* New: Added language support for German, Spanish, French, Portuguese and Russian
* New: Users with the `read_private_posts` capability can now view Archived content
* New: Automatically close comments and pings when content is archived
* Tweak: Allow mulitple post states to exist alongside Archived in edit screen
* Fix: The `aps_excluded_post_types` filter now works as expected on Edit screens
Props [fjarrett](https://github.com/fjarrett)
= 0.2.0 - January 21, 2015 =
* New: Make archived content read-only
Props [fjarrett](https://github.com/fjarrett), [pollyplummer](https://github.com/pollyplummer)
= 0.1.0 - January 4, 2015 =
* Initial release
Props [fjarrett](https://github.com/fjarrett)