readme.txt 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  1. === URLYar URL Shortner ===
  2. Contributors: Salamzadeh
  3. Donate link: http://urlyar.ir/donate
  4. Tags: urlyar, url-shortener, short url, url, shortlink, shorten, shortener, qr, qr code,
  5. Requires at least: 3.0.1
  6. Tested up to: 6.4.0
  7. Stable tag: trunk
  8. License: GPLv2 or later
  9. License URI: http://www.gnu.org/licenses/gpl-2.0.html
  10. This plugin allows you to generate shortlinks for post/pages using URLYar URL Shorteners
  11. == Description ==
  12. [URLYar URL Shortener](http://salamzadeh.net/plugins/urlyar/ "URLYar URL Shortener") allows you to generate shortlinks for post/pages using URLYar URL Shorteners, with a few additional features.
  13. **Features:**
  14. * Language file as 100% translation now available at wordpress.org
  15. * Localization - Persian translation added (100% complete)
  16. * QR Code Support (using Google Chart API Or URLYar QR API)
  17. * Nice ID links with QR Code (i.e. http://your_site/123.qr)
  18. * Automatic generation of a Short URL/Shortlinks
  19. * *Cached Shortlink* - thus generated only once.
  20. * Choose to generate shortlinks using permalinks or the posts ID (e.g. http://your_site/index.php?p=123).
  21. * Relatively extensive shortlink support
  22. * *Action Hooks available* for other plugins to utilize generated shortlinks (From Ver 3.0 Onwards)
  23. * Nice ID links - http://your_site/123 instead of http://your_site/index.php?p=123
  24. * Shortcode support: Place [urlyar_shortlink] in your article where you want to display the shortened url.
  25. * Append a link to short URL below your post content
  26. * Append a link to short URL below your page content
  27. * Append a link to short URL below your woocommerce product content
  28. **Available Template Tags**
  29. On-demand shortening function:
  30. `<?php urlyar_shorturl('http://www.wpnegar.com', 'urlyar'); ?>`
  31. To show the generated links::
  32. `<?php urlyar_show_shorturl($post); ?>`
  33. Or if WordPress 3.0:
  34. `<?php the_shortlink(); ?>`
  35. http://codex.wordpress.org/Function_Reference/the_shortlink
  36. **Available hooks and filters**
  37. * urlyar_use_shortlink (Action Hook)
  38. * urlyar_filter_shortlink (Filter)
  39. **Future Versions and on:**
  40. * More services/features can be added upon request (https://salamzadeh.net/plugins/urlyar)
  41. **Support via:**
  42. * http://wordpress.org/tags/url-shortener
  43. * Contact me via my website ( https://salamzadeh.net/contact/ )
  44. == Installation ==
  45. 1. Upload files to your `/wp-content/plugins/` directory (preserve sub-directory structure if applicable)
  46. 1. Activate the plugin through the 'Plugins' menu in WordPress
  47. Or
  48. 1. Within your WordPress admin, go to plugins > add new
  49. 1. Search for "URLYar URL Shortener".
  50. 1. Click Install Now for the plugin named "URLYar URL Shortener"
  51. == Frequently Asked Questions ==
  52. = What's Service Provider URL =
  53. Supported service provider is urlyar.ir
  54. you can register and use this services always free from (http://urlyar.ir/?lang=en) url
  55. URLYar is Free and Always Will Be
  56. == Screenshots ==
  57. https://salamzadeh.net/plugins/urlyar
  58. == Changelog ==
  59. Expanded list can be found at: http://salamzadeh.net/plugins/urlyar/release-history
  60. = 1.1.0 =
  61. * Connect to new version API's
  62. * Update to support new version of Wordpress
  63. = 1.0.5 =
  64. * Language file as 100% translation now available at wordpress.org
  65. * Localization - Persian translation added (100% complete)
  66. * Woocommerce Products support
  67. = 1.0 =
  68. * First Public Release
  69. * Added simple validation to options page
  70. = 0.5 =
  71. * Initial Private release.
  72. * supports URLYar
  73. == Upgrade Notice ==
  74. For those upgrading from a version prior to 1.0, please check your settings as Version 1.0 has options code that was re-written.
  75. Read More: http://salamzadeh.net/plugins/urlyar/upgrade-notes