Changeset 1234449

Timestamp:

08/31/2015 07:50:47 AM (11 years ago)

Author:

dansod

Message:

Added hooks and filters to make the plugin extensible

Location:

subscribe-to-category/trunk

Files:

• classes/class-subscribe.php (modified) (4 diffs)
• languages/stc_textdomain-lt_LT.mo (added)
• languages/stc_textdomain-lt_LT.po (added)
• readme.txt (modified) (4 diffs)
• subscribe-to-category.php (modified) (2 diffs)

subscribe-to-category/trunk/classes/class-subscribe.php

@@ -77 +77 @@
 
       // adding checkbox to publish meta box if activated
-      if( $this->settings['resend_option'] == 1 )
+      if( isset( $this->settings['resend_option'] ) && $this->settings['resend_option'] == 1 )
         add_action( 'post_submitbox_misc_actions', array( $this, 'resend_post_option' ) );
 
@@ -946 +946 @@
         $subject = '=?UTF-8?B?'.base64_encode( $email_subject ).'?=';
 
-        wp_mail( $email['email'], $subject, $message, $headers );
+
+        if( STC_DEV_MODE === true ){
+          echo $subject . '<br>' . $message;
+          die();
+        }else{
+          wp_mail( $email['email'], $subject, $message, $headers );  
+        }
+
 
         // sleep 2 seconds once every 25 email to prevent blacklisting
@@ -995 +1002 @@
      */    
     private function email_html_content( $email ){
+      $sum_of_words = 130;
+
+      $output['title']        = '<h3><a href="' . get_permalink( $email['post_id'] ) . '">' . $email['post']->post_title . '</a></h3>';
+      $output['link_to_post'] = '<div style="border-bottom: 1px solid #cccccc; padding-bottom: 10px;"><a href="' . get_permalink( $email['post_id'] ) .'">' . __('Click here to read full story', STC_TEXTDOMAIN ) . '</a></div>';
+      $output['unsubscribe']  = '<div style="margin-top: 20px;"><a href="' . get_bloginfo('url') . '/?stc_unsubscribe=' . $email['hash'] . '&stc_user=' . $email['email'] . '">' . __('Unsubscribe me', STC_TEXTDOMAIN ) . '</a></div>';
+
       ?>
-      <h3><a href="<?php echo get_permalink( $email['post_id']) ?>"><?php echo $email['post']->post_title; ?></a></h3>
-      <div><?php echo apply_filters('the_content', $this->string_cut( $email['post']->post_content, 130 ) );?></div>
-      <div style="border-bottom: 1px solid #cccccc; padding-bottom: 10px;"><a href="<?php echo get_permalink( $email['post_id'] ); ?>"> <?php _e('Click here to read full story', STC_TEXTDOMAIN ); ?></a></div>
-      <div style="margin-top: 20px;"><a href="<?php echo get_bloginfo('url') . '/?stc_unsubscribe=' . $email['hash'] . '&stc_user=' . $email['email']; ?>"><?php _e('Unsubscribe me', STC_TEXTDOMAIN ); ?></a></div>
+      <?php do_action( 'stc_before_message', $email['post_id'], $email['subscriber_id'] ); ?>
+      
+      <?php do_action( 'stc_before_message_title', $email['post_id'], $email['subscriber_id'] ); ?>
+      <?php echo apply_filters( 'stc_message_title_html', $output['title'], $email['post_id'], $email['subscriber_id'] ); ?>
+      <?php do_action( 'stc_after_message_title', $email['post_id'], $email['subscriber_id'] ); ?>
+
+      <?php do_action( 'stc_before_message_content', $email['post_id'], $email['subscriber_id'] ); ?>
+      <div><?php echo apply_filters('the_content', $this->string_cut( $email['post']->post_content, apply_filters( 'stc_message_length_sum_of_words', $sum_of_words ) ) );?></div>
+      <?php do_action( 'stc_after_message_content', $email['post_id'], $email['subscriber_id'] ); ?>
+
+      <?php echo apply_filters( 'stc_message_link_to_post_html', $output['link_to_post'] ); ?>
+      <?php echo apply_filters( 'stc_message_unsubscribe_html', $output['unsubscribe'] ); ?>
+
+      <?php do_action( 'stc_after_message', $email['post_id'], $email['subscriber_id'] ); ?>
+
       <?php
     }
@@ -1013 +1037 @@
      * @return string
      */
-    private function string_cut( $string, $max_length ){  
+    private function string_cut( $string, $max_length ){
+
+      if( $max_length < 0 )
+        return $string;
 
       // remove shortcode if there is

subscribe-to-category/trunk/readme.txt

@@ -3 +3 @@
 Tags: subscribe to post, subscribe to category, subscribe to news, subscribe
 Requires at least: 3.9
-Tested up to: 4.2.3
-Stable tag: 1.2.1
+Tested up to: 4.3
+Stable tag: 1.3
 License: GPLv2 or later
 License URI: http://www.gnu.org/licenses/gpl-2.0.html
@@ -35 +35 @@
 * French
 * Italian
+* Lithuanian
 * Russian
 * Spanish
@@ -56 +57 @@
 For both attributes you can use a comma sign to separate multiple categories, like [stc-subscribe category_in="news, article"].
 
+= Filter and hooks =
+Following filters and hooks can be used for customizing the email message.
+
+`<?php
+// FILTERS
+// Parameters: $value
+add_filter( 'stc_message_length_sum_of_words', 'stc_message_length_sum_of_words', 10, 1 ); //set return value to a negative number to show the full content
+
+
+// Parameters: $value, $post_id, $subscriber_post_id
+add_filter( 'stc_message_title_html', 'my_stc_message_title_html', 10, 3 );
+add_filter( 'stc_message_link_to_post_html', 'my_stc_message_link_to_post_html', 10, 3 );
+add_filter( 'stc_message_unsubscribe_html', 'my_stc_message_unsubscribe_html', 10, 3 );
+
+// HOOKS
+// Parameters: $post_id, $subscriber_post_id  
+add_action( 'stc_before_message', 'my_stc_before_message', 10, 2 );
+add_action( 'stc_before_message_title', 'my_stc_before_message_title', 10, 2 );
+add_action( 'stc_after_message_title', 'my_stc_after_message_title', 10, 2 );
+add_action( 'stc_before_message_content', 'my_stc_before_message_content', 10, 2 );
+add_action( 'stc_after_message_content', 'my_stc_after_message_content', 10, 2 );
+add_action( 'stc_after_message', 'my_stc_after_message', 10, 2 );
+
+
+/**
+ * Example for adding featured image to STC email
+ */
+function my_stc_after_message_title( $post_id ){
+    echo get_the_post_thumbnail( $post_id, 'thumbnail' );
+}
+add_action( 'stc_after_message_title', 'my_stc_after_message_title', 10, 2 );
+
+?>`
+
+
 = Optionally but recommended =
 As Wordpress Cron is depending on that you have visits on your website you should set up a cron job on your server to hit http://yourdomain.com/wp-cron.php at a regular interval to make sure that WP Cron is running as expected. In current version of Subscribe to Category the WP Cron is running once every hour, that might be an option that is changeable in future versions. 
@@ -68 +104 @@
 
 == Changelog ==
+
+= 1.3 =
+* Added hooks and filters to make the plugin extensible
+* Added Lithuanian language thanks to Claudio
 
 = 1.2.1 =

subscribe-to-category/trunk/subscribe-to-category.php

@@ -4 +4 @@
   Plugin URI: http://dcweb.nu
   Description: Lets your visitor subscribe to posts for one or several categories.
-  Version: 1.2.1
+  Version: 1.3
   Author: Daniel Söderström 
   Author URI: http://dcweb.nu/
@@ -18 +18 @@
   define( 'STC_PLUGIN_URL', plugin_dir_url( __FILE__ ) );
   define( 'STC_PLUGIN_PATH', dirname( __FILE__ ) );
+  define( 'STC_DEV_MODE', false ); // set to true email is printed out on setting page and will not be sent.
 
   require_once( 'classes/class-main.php' );