-
Notifications
You must be signed in to change notification settings - Fork 16
/
readme.txt
184 lines (123 loc) · 6.49 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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
=== WP Subtitle ===
Contributors: husobj, husani
Tags: subtitle, content, title, subheading, subhead, alternate title
Requires at least: 3.7
Tested up to: 4.4
Stable tag: 2.6
License: GPLv2
License URI: http://www.gnu.org/licenses/gpl-2.0.txt
Add subtitles (subheadings) to your pages, posts or custom post types.
== Description ==
The WP Subtitle plugin allows your pages and posts to contain a subtitle. Also called a sub-heading, this this short line of text is meant to appear beneath a post's (or page's) title, but can be inserted in your template wherever you choose.
`<?php the_subtitle(); ?>` is used for inside The Loop. If you wish to get a page/post's subtitle outside The Loop, use `<?php get_the_subtitle( $post ); ?>`, where $post is a post object or ID ($post->ID).
= Parameters =
Just like WP's built-in `<?php the_title(); ?>` method, `<?php the_subtitle(); ?>` tag accepts three parameters:
**$before**
*(string)* Text to place before the subtitle. Defaults to "".
**$after**
*(string)* Text to place after the subtitle. Defaults to "".
**$echo**
*(boolean)* If true, display the subtitle in HTML. If false, return the subtitle for use in PHP. Defaults to true.
Things are slightly different in `<?php get_the_subtitle(); ?>`:
**$post**
*(int|object)* Post, page or custom post type object or ID.
**$before**
*(string)* Text to place before the subtitle. Defaults to "".
**$after**
*(string)* Text to place after the subtitle. Defaults to "".
**$echo**
*(boolean)* If true, display the subtitle in HTML. If false, return the subtitle for use in PHP. Defaults to true.
For full details on the template tags and their arguments, [view the documentation here](https://github.com/benhuson/wp-subtitle/wiki).
By default, subtitle are supported by both posts and pages. To add support for custom post types use add_post_type_support( 'my_post_type', 'wps_subtitle' ).
== Installation ==
1. Upload the WP Subtitle plugin to your WordPress site in the `/wp-content/plugins` folder or install via the WordPress admin.
2. Activate it from the Wordpress plugin admin screen.
3. Edit your page and/or post template and use the `<?php the_subtitle(); ?>` template tag where you'd like the subtitle to appear.
For full details on the template tags and their arguments, [view the documentation here](https://github.com/benhuson/wp-subtitle/wiki).
== Frequently Asked Questions ==
= What does WP Subtitle do? =
The plugin adds a Subtitle field when editing posts or pages. The subtitle is stores as a custom field (post meta data) and can be output using template tags.
= Where does WP Subtitle store the subtitles? =
All subtitles are stored as post meta data. Deactivating this plugin will not remove those fields.
= How do I add the subtitle to my pages? =
Refer to [the documentation](https://github.com/benhuson/wp-subtitle/wiki).
= How do I add support for custom post types? =
To add support for custom post types use add_post_type_support( 'my_post_type', 'wps_subtitle' ):
`
function my_wp_subtitle_page_part_support() {
add_post_type_support( 'my_post_type', 'wps_subtitle' );
}
add_action( 'init', 'my_wp_subtitle_page_part_support' );
`
= Where can I get help? =
Please post support requests and questions in the [WordPress.org Support](http://wordpress.org/support/plugin/wp-subtitle) forum.
= How should I report a bug? =
Please submit bugs/errors directly to the [GitHub Issues](https://github.com/benhuson/wp-subtitle/issues) list.
= How can I contribute code? =
The plugin is [hosted on GitHub](https://github.com/benhuson/wp-subtitle) and pull requests are welcome.
== Screenshots ==
1. Edit post screen (WordPress 3.5+ and WP Title 2.2+)
1. Edit post screen (for earlier versions of WordPress or using the 'wps_subtitle_use_meta_box' filter)
2. A single page showing a subtitle
== Changelog ==
= 2.6 =
* Security Update: Sanitize `$_REQUEST` and `$_GET` when establishing post type in the admin.
* Added quick edit support for subtitle. Props [Fabian Marz](https://github.com/fabianmarz) and [sun](https://github.com/sun).
* Allow subtitle post meta key to be filtered using `wps_subtitle_key`.
* Add German translation. Props [hatsumatsu](https://github.com/hatsumatsu).
= 2.5 =
* Add [wp_subtitle] shortcode.
* Do not use variable for textdomain - causes issues for parsers.
* Declare methods as public or private.
= 2.4.1 =
* Fix PHP notice warning on 404 error page. Props Jay Williams.
* Add a little space above subtitle field when below title field in admin.
= 2.4 =
* Add subtitle admin column.
= 2.3.2 =
* Show subtitle admin field when adding new post. Props Gabriel Doty.
= 2.3.1 =
* Security Update: Ensure subtitles are sanitized when saving.
= 2.3 =
* Prevent subtitle fields from displaying on post types for which support has not been added using add_post_type_support(). Previously the fields were displayed but the subtitle would not be saved.
* Escape subtitle admin field value - fixes issues with subtitles with quotes.
= 2.2 =
* Added 'wps_subtitle_use_meta_box' filter to allow the edit field to be displayed in a meta box (the old way).
* Moved subtitle field from meta box to below title field in WordPress 3.5+ (props Tor Morten)
= 2.1 =
* Ready for translation - .pot file added.
* Added deprecated function warnings if WP_DEBUG enabled.
* Fix static method warnings.
* Only include admin functionality when needed.
= 2.0.1 =
* Use `<?php` instead of just `<?`.
* Break out some of the code into separate functions.
= 2.0 =
* Added custom post type support - use add_post_type_support( '{post_type}', 'wps_subtitle' ).
* Added 'wps_meta_box_title' filter.
* Added 'wps_subtitle' filter.
* Added 'wps_subtitle_field_description' filter.
* Fixed bug in more recent versions of WordPress.
= 1.0 =
* First version.
== Upgrade Notice ==
= 2.6 =
Added quick edit support for subtitle. Security Update: Sanitize `$_REQUEST` and `$_GET` when establishing post type in the admin.
= 2.5 =
Add [wp_subtitle] shortcode. Do not use variable for textdomain - causes issues for parsers.
= 2.4.1 =
Fix PHP notice warning on 404 error page.
= 2.4 =
Add subtitle admin column.
= 2.3.1 =
Security Update: Ensure subtitles are sanitized when saving.
= 2.3 =
Prevent subtitle fields from displaying on unsupported post types and fix issue with quotes in subtitles.
= 2.2 =
Subtitle field moved to below title field (only in WordPress 3.5+)
= 2.1 =
Fixed static method warnings and only load admin functionality when needed.
= 2.0 =
Added custom post type support and support for more recent versions of WordPress.
= 1.0 =
Initial release.