-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathreadme.txt
293 lines (210 loc) · 8.23 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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
=== Hello Dolly For Your Song ===
Contributors: unmus, jordansilaen
Tags: hello world, love, random, learning wordpress, admin
Requires at least: 5.2
Requires PHP: 7.0
Tested up to: 6.5.2
Stable tag: 0.19
License: GPLv3 or later
License URI: https://www.gnu.org/licenses/gpl-3.0.html
This simple plugin shows a random line of any text in your blog.
== Description ==
This simple plugin is an extended version of the famous hello dolly plugin by Matt Mullenweg. Every human being has a special relationship to a particular song. And because of that, Hello Dolly For Your Song brings the lyric of your favourite song in the blog. But of course it can be used for any text. ;-)
= Features =
* Display a random line of a custom text in your blog as gutenberg block
* Display a random line of a custom text in your blog as widget
* Display a random line of a custom text in your blog as shortcode
* Display a random line of a custom text in your theme as template tag
* Display a random line of a custom text in the blog administration
* Integration into WordPress REST API
* Hooks for Developers
* Options Page to define a custom song text
* Site Health Integration
* Hidden Options
* Languages: English, German, Spanish, French, Indonesian, Russian
= Related Links =
* <a href="https://www.unmus.de/hello-dolly-for-your-song/">Official Plugin Page</a> (German)
* <a href="https://www.unmus.de/hello-dolly/">Why I have created this plugin?</a> (German)
* <a href="https://www.unmus.de/hello-dolly-for-your-song/#screencast">ScreenCast showing almost all features</a> (German)
* <a href="https://github.com/circuscode/hello-dolly-for-your-song">Source Code @ GitHub</a>
== Installation ==
1. Download the plugin from the WordPress Plugin Repository
2. Activate the plugin in WordPress
3. Go to Settings > Hello Dolly Your Song to configure your songtext
== Frequently Asked Questions ==
= I have not maintained a songtext, nevertheless some lyrics is displayed in the admin head. =
This is Hello Dolly by Louis Armstrong. If no text is maintained in the options, the programm uses the songtext of Hello Dolly.
= Where do I find the gutenberg block? =
You find the block in the category "widgets".
= How can I use the shortcode? =
Type [hdfys] in a blank line in the WordPress editor.
= How can I bring the widget in the blog with a custom widget title? =
You can define the title in the settings of the widget.
= How can I integrate the random lyric in the theme? =
Use the template tag hello_dolly_for_your_song() in your theme file. The random line will directly printed embedded within a container.
= I do only want to use the capabilities in the frontend and fade out the text in the admin panel. Is this possible? =
You can use the hidden option for that! Please set the option "hdfys_admin_lyric" to 0 in the table wp_options within your WordPress database. Because of that the lyric in the admin panel will be faded out. Going back to standard settings, just set the value to 1.
= Can I assign custom css? =
Yes, you can. Each output of this plugin has individual css classes. Please use your debugging tools, to find the classes.
= How can I deinstall Hello Dolly For Your Song? =
You can use the regular way on the plugin page. After deinstallation your wordpress is really clean.
= I have maintained a continuous text and this breaks the admin layout partly? =
Helly Dolly For Your Song works for texts in poem style. This means you need a text with word wraps after each line or sentence. If you want to use a continuous text in the plugin, you should add word wraps after each sentence.
= Does the plugin provide an API? =
You can access the random line with the function get_hello_dolly_for_your_song() in other plugin code or via functions.php. The function returns just one single random line without markup for further processing.
= Does the plugin supports the WordPress REST API? =
Yes! :-D You can access the endpoint with http://yourblogdomain/wp-json/restful-hello-dolly-for-your-song/text. The endpoint delivers one random line back. So it's not really REST, it's only "READ".
= Is is possible to manipulate the HTML-output before rendering? =
The HTML-oupt of the gutenberg block, template tag or shortcode can be manipulated. This will be made with the Filter hdfys_output_filter. Below you find a code example.
= Why is the random line not shown on all admin pages? =
Several admin pages like settings are excluded, because some plugins do not use the wordpress standard layout. To avoid breaks in the user design, these pages are excluded.
== Screenshots ==
1. Options Page
== Changelog ==
= 0.19 =
* april 2024
* Security: Echo Escaping added
= 0.18 =
* april 2023
* Bugfix: LastChar is blank
* Bugfix: Installation Process
* Changed: Page Uploads excluded
* Others: Depreciated Authorization replaced
= 0.17 =
* may 2020
* Russian Translation
* Better Code Documentation
* Bugfix: Broken Plugin Administration Link
* Many internal improvements
= 0.16 =
* march 2020
* Site Health Integration
* Code Improvement
= 0.15 =
* january 2019
* Gutenberg Support
* Update Process Bugfix
* New Activation Criteria
= 0.14 =
* april 2018
* Random Line will printed on "classic" admin pages only
= 0.13 =
* 13 january 2018
* Gutenberg Plugin Support
* Automatic Removal of Empty Lines
* Plugin Actions
* Plugin Filters
* Code Improvement
= 0.12 =
* 16 july 2017
* Integration into WordPress REST API
* Source Code Comments to make wordpress plugin development concepts more transparent
= 0.11 =
* 04 april 2017
* Template Tag does not require Echo command anymore
* New Function available to get the raw random line for processing
* New Language: Indonesian
= 0.10 =
* 18 march 2017
* Options Link @ Plugin Page
= 0.9 =
* 26 december 2016
* French Language
* Hidden Options
* Security Improvements
* Internal Optimization
= 0.8 =
* 1 september 2016
* Template Tag
* New Labels
* Code Improvement
= 0.7 =
* 27 august 2016
* Settings API
* Update Process
= 0.6 =
* 09 august 2014
* Spanish Language
= 0.5 =
* 06 september 2013
* Shortcode
* Custom Widget Title
= 0.4 =
* 26 june 2013
* Widget
* Localization
* German language
* Clean deinstallation
* Bugfix: Processing of apostrophes
= 0.3 =
* 5 may 2013
* Structured and readable code
* First published version
= 0.2 =
* 4 may 2013
* Running version without errors
= 0.1 =
* 3 may 2013
* Running version
== Upgrade Notice ==
= 0.19 =
This version is a security release (no new features, but more secure code).
= 0.18 =
This version is a maintenance release (no new features, but bugfixes).
= 0.17 =
This version brings russian translation.
= 0.16 =
This version brings Site Health Integration.
= 0.15 =
This version brings Gutenberg Support.
= 0.14 =
This version brings more stability on the user interface
= 0.13 =
This version brings Gutenberg Plugin Support and some Hooks for WordPress Developers
= 0.12 =
This version supports the WordPress REST API and can be used better to learn WordPress Plugin Development
= 0.11 =
This version optimizes the template tag, brings a getter function and supports indonesian language.
= 0.10 =
This version includes only minor changes.
= 0.9 =
This version supports french language, hidden options and brings more security.
= 0.8 =
This version supports template tags for WordPress themes.
= 0.7 =
This version supports the WordPress Settings API.
== Configuration ==
1. Maintain the songtext you love in the Settings.
2. That is all!
= Gutenberg Block Category =
Widgets
= Shortcode =
[hdfys]
= Template Tag =
hello_dolly_for_your_song()
= Get Function =
get_hello_dolly_for_your_song()
= REST API Endpoint =
http://yourblogdomain/wp-json/restful-hello-dolly-for-your-song/text
= Actions =
hdfys_new_song
This Action wil be fired, if a new text was maintained in the settings.
You can use the following code.
`function hdfys_do_anything() {`
``
` // Add your code to execute here`
``
`}`
`add_action( 'hdfys_new_song', 'hdfys_do_anything', 10, 3 );`
= Filter =
hdfys_output_filter
The filter will be applied before output of the gutenberg block, template tag and shortcode.
You can use the following code.
`function hdfys_output_manipulate( $output ) {`
``
` // Add your filter code here`
` // Example: $output=strtolower( $output );`
``
` return $output;`
`}`
`add_filter( 'hdfys_output_filter', 'hdfys_output_manipulate', 10, 1 );`