FAQ added , Version update, code fixed

Author: codehaveli

FAQ.md

@@ -0,0 +1,39 @@
+# Codehaveli Bitly URL Shortener
+
+## Frequently Asked Questions
+
+### How to get the short link of a post?
+
+```
+$link = get_wbitly_short_url($post_id); // link or false
+
+```
+
+### How to generate shortlink of a link?
+
+```
+$short_link = wbitly_generate_shorten_url($long_link); // link or false
+```
+
+### How can i change the URL before the shorten process?
+
+```
+add_filter('wbitly_url_before_process' , 'modify_permalink_of_post' , 10 , 1);
+function modify_permalink_of_post($permalink){
+	return $permalink;
+}
+
+```
+
+You can use `wbitly_url_before_process` filter to change the URL/Permalink. Call back function accepts the permalink.
+
+### How can i hook into the generated URL?
+
+```
+add_action('wbitly_shorturl_updated' , 'post_to_other' , 10 , 1);
+function post_to_other($url){
+ // do anything with $url
+}
+```
+
+We can use the hook to do get the short url and use it accordingly

README.md

@@ -1,31 +1,23 @@
-
 <p align="center">
   <img src="sc/banner-1544x500.png?raw=true">
 </p>
 
-# Codehaveli Bitly URL Shortener 
+# Codehaveli Bitly URL Shortener
 
 ### Description
 
-[Codehaveli Bitly URL Shortener](https://wordpress.org/plugins/codehaveli-bitly-url-shortener/) allow you to connect your WordPress Website to the https://bitly.com/ account via access code.
-
-This Plugin enables Bitly User to generate short link automatically from Wordpress when they publish new post. 
-
-This plugin use the functionality of **Bitly API** and generate short link and also get your group Guid from your Bitly account [During Your Settings ].
-
-
+[Codehaveli Bitly URL Shortener](https://wordpress.org/plugins/codehaveli-bitly-url-shortener/) uses the functionality of Bitly API to generate the short link automatically from your WordPress dashboard.
 
+Codehaveli Bitly URL Shortener allows you to connect your WordPress Website to the Bitly API via access code.
 
-### Terms of Use 
+### Terms of Use
 
 This is not a Official plugin of [Bitly](https://bitly.com)
 
 This plugin only connect your [https://bitly.com](https://bitly.com) account to WordPress.
 
 Please read [privacy](https://bitly.com/pages/privacy) and [terms of service](https://bitly.com/pages/terms-of-service) of [Bitly](https://bitly.com) before using this plugin.
 
-
-
 ### Bug reports
 
 Bug reports for Codehaveli Bitly URL Shortener are welcomed in our Codehaveli Bitly URL Shortener [repository on GitHub](https://github.com/codehaveli/codehaveli-bitly-url-shortener). Please note that GitHub is not a support forum, and that issues that are not properly qualified as bugs will be closed.
@@ -34,9 +26,7 @@ Bug reports for Codehaveli Bitly URL Shortener are welcomed in our Codehaveli Bi
 
 For more info on Bitly and Codehaveli , check out the following:
 
-* [Codehaveli](https://bit.ly/2A8QyGt) official homepage.
-* Bitly Access Token Generate Process from [Codehaveli Blog](https://bit.ly/2X1Hvjz)
-* Bitly [API Documentation](https://bitly.is/2XxT9BN) 
-* Follow Codehaveli on [Facebook](https://www.facebook.com/codehaveli), [Instagram](https://www.instagram.com/codehaveli/) & [Twitter](https://twitter.com/codehaveli).
-
-
+- [Codehaveli](https://www.codehaveli.com/) official homepage.
+- Read "How to generate Bitly OAuth access token" from [Codehaveli Blog](https://bit.ly/2X1Hvjz)
+- Bitly [API Documentation](https://bitly.is/2XxT9BN)
+- Follow Codehaveli on [Facebook](https://www.facebook.com/codehaveli), [Instagram](https://www.instagram.com/codehaveli/) & [Twitter](https://twitter.com/codehaveli).

codehaveli-bitly-url-shortener.php

@@ -4,7 +4,7 @@
 Plugin Name: Codehaveli Bitly URL Shortener
 Plugin URI: https://github.com/codehaveli/
 Description: This Plugin is used for shorten the newly published post url, Plugin use the api functionality of  https://bitly.com/  to achive this URL shorten process.
-Version: 1.1
+Version: 1.1.1
 Author: Codehaveli
 Author URI: https://www.codehaveli.com/
 License: GPLv2 or later
@@ -16,11 +16,13 @@
 
 define( 'WBITLY_PLUGIN_PATH', plugin_dir_path( __FILE__ ) ); 
 define( 'WBITLY_PLUGIN_URL', plugin_dir_url( __FILE__ ) );	
-define( 'WBITLY_PLUGIN_VERSION', '1.1' );
+define( 'WBITLY_PLUGIN_VERSION', '1.1.1' );
 define( 'WBITLY_API_URL', 'https://api-ssl.bitly.com' );
 define( 'WBITLY_BASENAME', plugin_basename( __FILE__ ) );
 define( 'WBITLY_SETTINGS_URL', admin_url( 'tools.php?page=wbitly' ) );
 
+// https://raventools.com/marketing-reports/google-analytics/url-builder/?utm_source=Social%20Network&utm_medium=link&utm_campaign=Bitly&utm_term=Term&utm_content=Content
+
 
 
 

inc/wbitly-integration.php

@@ -6,7 +6,7 @@
  * @Last Modified by:   Codehaveli
  * @Website: www.codehaveli.com
  * @Email: hello@codehaveli.com
- * @Last Modified time: 2020-06-29 20:03:48
+ * @Last Modified time: 2020-06-30 19:03:04
  */
 
 
@@ -83,7 +83,7 @@ function wbitly_generate_shorten_url($permalink){
 
 function wbitly_shorten_url ($permalink) {
 
-  _deprecated_function( 'wbitly_shorten_url', '1.0.1', 'wbitly_generate_shorten_url' );
+  _deprecated_function( 'wbitly_shorten_url', '1.1', 'wbitly_generate_shorten_url' );
 
 
   return wbitly_generate_shorten_url($permalink);

inc/wbitly-settings.php

@@ -6,7 +6,7 @@
  * @Last Modified by:   Codehaveli
  * @Website: www.codehaveli.com
  * @Email: hello@codehaveli.com
- * @Last Modified time: 2020-06-29 19:32:16
+ * @Last Modified time: 2020-08-20 09:27:42
  */
 
 
@@ -148,14 +148,14 @@ public function wbitly_get_bitly_guid_request($access_token){
 
 				$error     = $http_response->get_error_message();
 				$pluginlog = plugin_dir_path(__FILE__).'error.log';
-				$message   = $error .WBITLY_PLUGIN_VERSION .PHP_EOL;
+				$message   = $error . PHP_EOL;
 				error_log($message, 3, $pluginlog);
              }
 
 		} catch (Exception $e) {
 
 			$pluginlog = plugin_dir_path(__FILE__).'debug.log';
-			$message   = 'Unable to get Bitly GUID  This message was added in version '.WBITLY_PLUGIN_VERSION .PHP_EOL;
+			$message   = 'Unable to get Bitly GUID' . PHP_EOL;
 			error_log($message, 3, $pluginlog);
 		}
 

inc/wbitly-util.php

@@ -86,7 +86,7 @@ function wbitly_get_template( $template_name, $template_path = '', $default_path
     $located = wbitly_locate_template( $template_name, $template_path, $default_path );
 
     if ( ! file_exists( $located ) ) {
-        _doing_it_wrong( __FUNCTION__, sprintf( '<code>%s</code> does not exist.', esc_html( $located ) ), '1.0.1' );
+        _doing_it_wrong( __FUNCTION__, sprintf( '<code>%s</code> does not exist.', esc_html( $located ) ), WBITLY_PLUGIN_VERSION );
         return;
     }