Yet Another Related Posts Plugin (YARPP) - Version 4.0.8

Version Description

  • The recent 4.0.7 YARPP update included a settings modification to opt in users to our tracking pixel by default. By doing so, our intent was to use this expanded information to better understand the geographic reach of the popular plugin. We have been made aware that this change infringed upon the WordPress guidelines. We apologize for the issue and have remedied the situation in update 4.0.8. Going forward, we would really appreciate your input to help us continue to improve the product. We are primarily looking for country, domain, and date installed information. Please help us make YARPP better by opting in to this information and by filling out our quick, 5 question survey. Thank you.
Download this release

Release Info

Developer jeffparker
Plugin Icon 128x128 Yet Another Related Posts Plugin (YARPP)
Version 4.0.8
Comparing to
See all releases

Code changes from version 4.0.7 to 4.0.8

Files changed (4) hide show
  1. class-admin.php +21 -6
  2. options-meta-boxes.php +15 -4
  3. readme.txt +57 -17
  4. yarpp.php +2 -2
class-admin.php CHANGED
@@ -163,10 +163,18 @@ class YARPP_Admin {
163
'<p>'.
164
__("With your permission, YARPP will send information about YARPP's settings, usage, and environment
165
back to a central server at ", 'yarpp').'<code>yarpp.org</code>'.'.&nbsp;'.
166
__("This information will be used to improve YARPP in the future and help decide future development
167
decisions for YARPP.",
168
'yarpp'
169
).' '.
170
'<strong>'.
171
__("Contributing this data will help make YARPP better for you and for other YARPP users.",
172
'yarpp' ).'</strong>'.
@@ -271,12 +279,19 @@ class YARPP_Admin {
271
);
272
}
273
274
- _e(
275
- "<p>".
276
- "YARPP would like to use your site&#39;s usage statistics to make more informed decisions about future development. ".
277
- "Optionally, this can be disabled by clicking on the button below.".
278
- "</p>"
279
- ,'yarpp' );
280
281
echo '</p><p>';
282
$this->print_optin_button($action);
163
'<p>'.
164
__("With your permission, YARPP will send information about YARPP's settings, usage, and environment
165
back to a central server at ", 'yarpp').'<code>yarpp.org</code>'.'.&nbsp;'.
166
+ '</p>'.
167
+ '<p>'.
168
+ 'We would really appreciate your input to help us continue to improve the product. We are primarily looking '.
169
+ 'for country, domain, and date installed information.'.
170
+ '</p>'.
171
+ '<p>'.
172
__("This information will be used to improve YARPP in the future and help decide future development
173
decisions for YARPP.",
174
'yarpp'
175
).' '.
176
+ '</p>'.
177
+ '<p>'.
178
'<strong>'.
179
__("Contributing this data will help make YARPP better for you and for other YARPP users.",
180
'yarpp' ).'</strong>'.
279
);
280
}
281
282
+ echo (
283
+ '<p>'.
284
+ 'We would really appreciate your input to help us continue to improve the product. We are primarily looking '.
285
+ 'for country, domain, and date installed information.'.
286
+ '</p>'.
287
+ '<p>'.
288
+ 'Please help us make YARPP better providing this information and by filling out our quick, '.
289
+ '5 question survey: '.
290
+ '<a href="http://www.surveymonkey.com/s/Z278L88" target="_blank">'.
291
+ 'http://www.surveymonkey.com/s/Z278L88'.
292
+ '</a>'.
293
+ '</p>'
294
+ );
295
296
echo '</p><p>';
297
$this->print_optin_button($action);
options-meta-boxes.php CHANGED
@@ -432,14 +432,25 @@ class YARPP_Meta_Box_Optin extends YARPP_Meta_Box {
432
'</label>'
433
);
434
435
- echo(
436
- '<p style="overflow:auto;">'.
437
- __( 'This is entirely optional, but will help improve future versions of YARPP.', 'yarpp' ).
438
- '<br/>'.
439
'<input type="button" value="'.esc_attr(__('Learn More', 'yarpp')).'" id="yarpp-optin-learnmore" class="button button-small"/>'.
440
'</p>'
441
);
442
}/*end display*/
443
}/*YARPP_Meta_Box_Optin*/
444
445
add_meta_box( 'yarpp_display_contact', __( 'Contact YARPP', 'yarpp' ), array( new YARPP_Meta_Box_Contact, 'display' ), 'settings_page_yarpp', 'side', 'core' );
432
'</label>'
433
);
434
435
+ echo (
436
+ '<p>'.
437
+ 'We would really appreciate your input to help us continue to improve the product. We are primarily looking '.
438
+ 'for country, domain, and date installed information.'.
439
+ '</p>'.
440
+ '<p>'.
441
+ 'Please help us make YARPP better providing this information and by filling out our quick, '.
442
+ '5 question survey: '.
443
+ '<a href="http://www.surveymonkey.com/s/Z278L88" target="_blank">'.
444
+ 'http://www.surveymonkey.com/s/Z278L88'.
445
+ '</a>'.
446
+ '<br/><br/>'.
447
'<input type="button" value="'.esc_attr(__('Learn More', 'yarpp')).'" id="yarpp-optin-learnmore" class="button button-small"/>'.
448
+ '<br/>'.
449
'</p>'
450
);
451
+
452
}/*end display*/
453
+
454
}/*YARPP_Meta_Box_Optin*/
455
456
add_meta_box( 'yarpp_display_contact', __( 'Contact YARPP', 'yarpp' ), array( new YARPP_Meta_Box_Contact, 'display' ), 'settings_page_yarpp', 'side', 'core' );
readme.txt CHANGED
@@ -6,7 +6,7 @@ Plugin URI: http://yarpp.org/
6
Tags: related, posts, post, pages, page, RSS, feed, feeds, YARPP
7
Requires at least: 3.3
8
Tested up to: 3.6.1
9
- Stable tag: 4.0.7
10
License: GPLv2 or later
11
12
Display a list of related entries on your site and feeds based on a unique algorithm. Now with thumbnail support built-in!
@@ -78,7 +78,7 @@ YARPP allows the advanced user with knowledge of PHP to customize the display of
78
79
== Frequently Asked Questions ==
80
81
- If your question isn't here, ask your own question at [the WordPress.org forums](http://wordpress.org/support/plugin/yet-another-related-posts-plugin). *Please do not email with questions.* I'd also appreciate if you would tell me how you found out about YARPP, by taking [this simple three-question survey](http://www.surveymonkey.com/s/Z278L88). Thanks for your feedback!
82
83
= Many pages list "no related posts." =
84
@@ -196,35 +196,72 @@ Before upgrading to a new WordPress version, you should first deactivate all plu
196
197
The official [YARPP Experiments](http://wordpress.org/extend/plugins/yarpp-experiments/) plugin adds manual cache controls, letting you flush the cache and build it up manually.
198
199
- = I removed the YARPP plugin but I still see YARPP-related database tables. Shouldn't those be removed, too? =
200
201
Beginning with version 4.0.7, YARPP includes clean uninstall functionality. If you no longer wish to use YARPP, first deactivate YARPP using the "Plugins" page in WordPress, then click the "Delete" link found on the same page. This process will automatically remove all YARPP-related files, including temp tables. If you manually try to remove YARPP files instead of going through WordPress, some files or temp tables could remain.
202
203
- == Developing with YARPP ==
204
205
- = Custom post types =
206
207
- To make YARPP support your custom post type, the attribute `yarpp_support` must be set to true on the custom post type when it is registered. It will then be available on options on the YARPP settings page.
208
209
If you would like to programmatically control which post types are considered in an automatically-displayed related posts display, use the `yarpp_map_post_types` filter.
210
211
- = Custom displays =
212
213
- Developers can call YARPP's powerful relatedness algorithm from anywhere in their own code. Some examples and more details are in my slides from my [WordCamp Birmingham talk](http://www.slideshare.net/mitcho/relate-all-the-things).
214
215
- Options which are not specified will default to those specified in the YARPP settings page. Additionally, if you are using the builtin template rather than specifying a custom template file in `template`, the following arguments can be used to override the various parts of the builtin template: `before_title`, `after_title`, `before_post`, `after_post`, `before_related`, `after_related`, `no_results`, `excerpt_length`.
216
217
- If you need to use related entries programmatically or to know whether they exist, you can use the functions `yarpp_get_related($args, $reference_ID)` and `yarpp_related_exist($args, $reference_ID)`. `yarpp_get_related` returns an array of `post` objects, just like the WordPress function `get_posts`. `yarpp_related_exist` returns a boolean for whether any such related entries exist. For each function, `$args` takes the same arguments as those shown for `yarpp_related` above, except for the various display and template options.
218
219
Note that custom YARPP queries using the functions mentioned here are *not* cached in the built-in YARPP caching system. Thus, if you notice any performance hits, you may need to write your own code to cache the results.
220
221
- = Custom taxonomy support =
222
223
- Any taxonomy, including custom taxonomies, may be specified in the `weight` or `require_tax` arguments in a custom display as above. `term_taxonomy_id`s specified in the `exclude` argument may be of any taxonomy.
224
225
If you would like to choose custom taxonomies to choose in the YARPP settings UI, either to exclude certain terms or to consider them in the relatedness formula via the UI, the taxonomy must (a) have either the `show_ui` or `yarpp_support` attribute set to true and (b) must apply to either the post types `post` or `page` or both.
226
227
- == Localizations ==
228
229
YARPP is currently localized in the following languages:
230
@@ -254,7 +291,7 @@ YARPP is currently localized in the following languages:
254
* Kazakh (`kk_KZ`) by [DachaDecor](http://DachaDecor.ru)
255
* Korean (`ko_KR`) by [Jong-In Kim](http://incommunity.codex.kr)
256
* Latvian (`lv_LV`) by [Mike](http://antsar.info)
257
- * Lithuanian (`lt_LT`) by [Karolis Vyčius](http://vycius.co.cc) and [Mantas Malcius](http://mantas.malcius.lt)
258
* Macedonian (`mk_MK`) by [WPdiscounts](http://wpdiscounts.com)
259
* Norwegian (`nb_NO`) by [Tom Arne Sundtjønn](http://www.datanerden.no)
260
* Polish (`pl_PL`) by [Perfecta](http://perfecta.pro/wp-pl/)
@@ -262,18 +299,21 @@ YARPP is currently localized in the following languages:
262
* Brazilian Portuguese (`pt_BR`) by Rafael Fischmann of [macmagazine.br](http://macmagazine.com.br/)
263
* Romanian (`ro_RO`) by [Uhren Shop](http://uhrenstore.de/)
264
* Russian (`ru_RU`) by Marat Latypov of [blogocms.ru](http://blogocms.ru)
265
- * Serbian (`sr_RS`) by [Zarko Zivkovic](http://www.zarkozivkovic.com/)
266
* Slovak (`sk_SK`) by [Forex](http://www.eforex.sk/)
267
- * Slovenian (`sl_SI`) by [Silvo Katalenić](http://www.twitter.com/silvoslaf)
268
* Spanish (`es_ES`) by Rene of [WordPress Webshop](http://wpwebshop.com)
269
* Swedish (`sv_SE`) by Max Elander
270
- * Turkish (`tr_TR`) by [Nurullah](http://www.ndemir.com) and [Barış Ünver](http://beyn.org/)
271
* Vietnamese (`vi_VN`) by Vu Nguyen of [Rubik Integration](http://rubikintegration.com/)
272
* Ukrainian (`uk_UA`) by [Onore(Alexander Musevich)](http://Onore.kiev.ua)
273
* Uzbek (`uz_UZ`) by Ali Safarov of [comfi.com](http://www.comfi.com/)
274
275
== Changelog ==
276
277
= 4.0.7 =
278
* [Bugfix](https://wordpress.org/support/topic/orderby-error): Now more robust against certain custom options.
279
* Updated plugin de-activate/delete functionality to drop all tables. Prior to fix some legacy tables remained which required manual deletion in wp_options from phpmyadmin.
6
Tags: related, posts, post, pages, page, RSS, feed, feeds, YARPP
7
Requires at least: 3.3
8
Tested up to: 3.6.1
9
+ Stable tag: 4.0.8
10
License: GPLv2 or later
11
12
Display a list of related entries on your site and feeds based on a unique algorithm. Now with thumbnail support built-in!
78
79
== Frequently Asked Questions ==
80
81
+ If your question isn't here, ask your own question at [the WordPress.org forums](http://wordpress.org/support/plugin/yet-another-related-posts-plugin). *Please do not email with questions.* I'd also appreciate if you would tell me how you found out about YARPP, by taking [this quick five-question survey](http://www.surveymonkey.com/s/Z278L88). Thanks for your feedback!
82
83
= Many pages list "no related posts." =
84
196
197
The official [YARPP Experiments](http://wordpress.org/extend/plugins/yarpp-experiments/) plugin adds manual cache controls, letting you flush the cache and build it up manually.
198
199
+ = I removed the YARPP plugin but I still see YARPP-related database tables. Shouldn't those be removed, too? =
200
201
Beginning with version 4.0.7, YARPP includes clean uninstall functionality. If you no longer wish to use YARPP, first deactivate YARPP using the "Plugins" page in WordPress, then click the "Delete" link found on the same page. This process will automatically remove all YARPP-related files, including temp tables. If you manually try to remove YARPP files instead of going through WordPress, some files or temp tables could remain.
202
203
+ = Does YARPP support custom post types? =
204
205
+ Yes. To make YARPP support your custom post type, the attribute `yarpp_support` must be set to true on the custom post type when it is registered. It will then be available on options on the YARPP settings page.
206
207
+ `
208
+ 'yarpp_support' => true
209
+ `
210
211
If you would like to programmatically control which post types are considered in an automatically-displayed related posts display, use the `yarpp_map_post_types` filter.
212
213
+ = Can I customize how YARPP displays? =
214
+
215
+ Yes. Developers can call YARPP's powerful relatedness algorithm from anywhere in their own code. Some examples and more details are in my slides from my [WordCamp Birmingham talk](http://www.slideshare.net/mitcho/relate-all-the-things).
216
217
+ `
218
+ yarpp_related(array(
219
+ // Pool options: these determine the "pool" of entities which are considered
220
+ 'post_type' => array('post', 'page', ...),
221
+ 'show_pass_post' => false, // show password-protected posts
222
+ 'past_only' => false, // show only posts which were published before the reference post
223
+ 'exclude' => array(), // a list of term_taxonomy_ids. entities with any of these terms will be excluded from consideration.
224
+ 'recent' => false, // to limit to entries published recently, set to something like '15 day', '20 week', or '12 month'.
225
+
226
+ // Relatedness options: these determine how "relatedness" is computed
227
+ // Weights are used to construct the "match score" between candidates and the reference post
228
+ 'weight' => array(
229
+ 'body' => 1,
230
+ 'title' => 2, // larger weights mean this criteria will be weighted more heavily
231
+ 'tax' => array(
232
+ 'post_tag' => 1,
233
+ ... // put any taxonomies you want to consider here with their weights
234
+ )
235
+ ),
236
+ // Specify taxonomies and a number here to require that a certain number be shared:
237
+ 'require_tax' => array(
238
+ 'post_tag' => 1 // for example, this requires all results to have at least one 'post_tag' in common.
239
+ ),
240
+ // The threshold which must be met by the "match score"
241
+ 'threshold' => 5,
242
+
243
+ // Display options:
244
+ 'template' => , // either the name of a file in your active theme or the boolean false to use the builtin template
245
+ 'limit' => 5, // maximum number of results
246
+ 'order' => 'score DESC'
247
+ ),
248
+ $reference_ID, // second argument: (optional) the post ID. If not included, it will use the current post.
249
+ true); // third argument: (optional) true to echo the HTML block; false to return it
250
+ `
251
252
+ Options which are not specified will default to those specified in the YARPP settings page. Additionally, if you are using the built-in template rather than specifying a custom template file in `template`, the following arguments can be used to override the various parts of the builtin template: `before_title`, `after_title`, `before_post`, `after_post`, `before_related`, `after_related`, `no_results`, `excerpt_length`.
253
254
+ If you need to use related entries programmatically or to know whether they exist, you can use the functions `yarpp_get_related($args, $reference_ID)` and `yarpp_related_exist($args, $reference_ID)`. `yarpp_get_related` returns an array of `post` objects, just like the WordPress function `get_posts`. `yarpp_related_exist` returns a boolean for whether any such related entries exist. For each function, `$args` takes the same arguments as those shown for `yarpp_related` above, except for the various display and template options.
255
256
Note that custom YARPP queries using the functions mentioned here are *not* cached in the built-in YARPP caching system. Thus, if you notice any performance hits, you may need to write your own code to cache the results.
257
258
+ = Does YARPP support custom taxonomies? =
259
260
+ Yes. Any taxonomy, including custom taxonomies, may be specified in the `weight` or `require_tax` arguments in a custom display as above. `term_taxonomy_id`s specified in the `exclude` argument may be of any taxonomy.
261
262
If you would like to choose custom taxonomies to choose in the YARPP settings UI, either to exclude certain terms or to consider them in the relatedness formula via the UI, the taxonomy must (a) have either the `show_ui` or `yarpp_support` attribute set to true and (b) must apply to either the post types `post` or `page` or both.
263
264
+ = Which languages does YARPP support? =
265
266
YARPP is currently localized in the following languages:
267
291
* Kazakh (`kk_KZ`) by [DachaDecor](http://DachaDecor.ru)
292
* Korean (`ko_KR`) by [Jong-In Kim](http://incommunity.codex.kr)
293
* Latvian (`lv_LV`) by [Mike](http://antsar.info)
294
+ * Lithuanian (`lt_LT`) by [Karolis Vycius](http://vycius.co.cc) and [Mantas Malcius](http://mantas.malcius.lt)
295
* Macedonian (`mk_MK`) by [WPdiscounts](http://wpdiscounts.com)
296
* Norwegian (`nb_NO`) by [Tom Arne Sundtjønn](http://www.datanerden.no)
297
* Polish (`pl_PL`) by [Perfecta](http://perfecta.pro/wp-pl/)
299
* Brazilian Portuguese (`pt_BR`) by Rafael Fischmann of [macmagazine.br](http://macmagazine.com.br/)
300
* Romanian (`ro_RO`) by [Uhren Shop](http://uhrenstore.de/)
301
* Russian (`ru_RU`) by Marat Latypov of [blogocms.ru](http://blogocms.ru)
302
+ * Serbian (`sr_RS`) by [Zarko Zivkovic](http://www.zarkozivkovic.com/)
303
* Slovak (`sk_SK`) by [Forex](http://www.eforex.sk/)
304
+ * Slovenian (`sl_SI`) by [Silvo Katalenic](http://www.twitter.com/silvoslaf)
305
* Spanish (`es_ES`) by Rene of [WordPress Webshop](http://wpwebshop.com)
306
* Swedish (`sv_SE`) by Max Elander
307
+ * Turkish (`tr_TR`) by [Nurullah](http://www.ndemir.com) and [Baris Ünver](http://beyn.org/)
308
* Vietnamese (`vi_VN`) by Vu Nguyen of [Rubik Integration](http://rubikintegration.com/)
309
* Ukrainian (`uk_UA`) by [Onore(Alexander Musevich)](http://Onore.kiev.ua)
310
* Uzbek (`uz_UZ`) by Ali Safarov of [comfi.com](http://www.comfi.com/)
311
312
== Changelog ==
313
314
+ = 4.0.8 =
315
+ * The recent 4.0.7 YARPP update included a settings modification to opt in users to our tracking pixel by default. By doing so, our intent was to use this expanded information to better understand the geographic reach of the popular plugin. We have been made aware that this change infringed upon the WordPress guidelines. We apologize for the issue and have remedied the situation in update 4.0.8. Going forward, we would really appreciate your input to help us continue to improve the product. We are primarily looking for country, domain, and date installed information. Please help us make YARPP better by opting in to this information and by filling out our quick, [5 question survey](http://www.surveymonkey.com/s/Z278L88). Thank you.
316
+
317
= 4.0.7 =
318
* [Bugfix](https://wordpress.org/support/topic/orderby-error): Now more robust against certain custom options.
319
* Updated plugin de-activate/delete functionality to drop all tables. Prior to fix some legacy tables remained which required manual deletion in wp_options from phpmyadmin.
yarpp.php CHANGED
@@ -3,12 +3,12 @@
3
Plugin Name: Yet Another Related Posts Plugin
4
Plugin URI: http://yarpp.org/
5
Description: Returns a list of related entries based on a unique algorithm for display on your blog and RSS feeds. Now with thumbnail support built-in!
6
- Version: 4.0.7
7
Author: mitcho (Michael Yoshitaka Erlewine)
8
Author URI: http://mitcho.com/
9
*/
10
11
- define('YARPP_VERSION', '4.0.7');
12
define('YARPP_DIR', dirname(__FILE__));
13
define('YARPP_NO_RELATED', ':(');
14
define('YARPP_RELATED', ':)');
3
Plugin Name: Yet Another Related Posts Plugin
4
Plugin URI: http://yarpp.org/
5
Description: Returns a list of related entries based on a unique algorithm for display on your blog and RSS feeds. Now with thumbnail support built-in!
6
+ Version: 4.0.8
7
Author: mitcho (Michael Yoshitaka Erlewine)
8
Author URI: http://mitcho.com/
9
*/
10
11
+ define('YARPP_VERSION', '4.0.8');
12
define('YARPP_DIR', dirname(__FILE__));
13
define('YARPP_NO_RELATED', ':(');
14
define('YARPP_RELATED', ':)');