Changeset 8081 for sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-bbp-term-subscription/inc/class-plugin.php

Timestamp:

01/15/2019 03:10:41 AM (8 years ago)

Author:

dd32

Message:

Support Forums: Prefix notifications from the Plugin/Theme forums with the plugin name.

For example: [WordPress.org] [Example Plugin Name] Example Topic Title.

Fixes #2016.

File:

• sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-bbp-term-subscription/inc/class-plugin.php (modified) (10 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-bbp-term-subscription/inc/class-plugin.php

@@ -12 +12 @@
         private $subscribers = array();
 
-        public $taxonomy = false;
-        public $labels   = array();
+        public $taxonomy  = false;
+        public $labels    = array();
+        public $directory = false;
 
         const META_KEY = '_bbp_term_subscription';
@@ -19 +20 @@
         public function __construct( $args = array() ) {
                 $r = wp_parse_args( $args, array(
-                        'taxonomy' => 'topic-tag',
-                        'labels'   => array(
+                        'taxonomy'  => 'topic-tag',
+                        'directory' => false,
+                        'labels'    => array(
                                 'subscribed_header'      => __( 'Subscribed Topic Tags', 'wporg-forums' ),
                                 'subscribed_user_notice' => __( 'You are not currently subscribed to any topic tags.', 'wporg-forums' ),
@@ -28 +30 @@
                 ) );
 
-                $this->taxonomy = $r['taxonomy'];
-                $this->labels   = $r['labels'];
+                $this->taxonomy  = $r['taxonomy'];
+                $this->labels    = $r['labels'];
+                $this->directory = $r['directory'];
 
                 add_action( 'bbp_init', array( $this, 'bbp_init' ) );
@@ -157 +160 @@
          * @param int $topic_author The topic author id
          */
-        public function notify_term_subscribers_of_new_topic( $topic_id, $forum_id,  $anonymous_data = false, $topic_author = 0 ) {
+        public function notify_term_subscribers_of_new_topic( $topic_id, $forum_id, $anonymous_data = false, $topic_author = 0 ) {
                 $terms = get_the_terms( $topic_id, $this->taxonomy );
                 if ( ! $terms ) {
@@ -185 +188 @@
                 // Replace forum-specific messaging with term subscription messaging.
                 add_filter( 'bbp_forum_subscription_mail_message', array( $this, 'replace_forum_subscription_mail_message' ), 10, 4 );
+                add_filter( 'bbp_forum_subscription_mail_title',   array( $this, 'replace_forum_subscription_mail_title' ), 10, 2 );
 
                 // Replace forum subscriber list with term subscribers, avoiding duplicates.
@@ -193 +197 @@
 
                 // Remove filters.
-                remove_filter( 'bbp_forum_subscription_user_ids', array( $this, 'add_term_subscribers_to_forum' ) );
+                remove_filter( 'bbp_forum_subscription_user_ids',     array( $this, 'add_term_subscribers_to_forum' ) );
                 remove_filter( 'bbp_forum_subscription_mail_message', array( $this, 'replace_forum_subscription_mail_message' ), 10 );
+                remove_filter( 'bbp_forum_subscription_mail_title',   array( $this, 'replace_forum_subscription_mail_title' ) );
+
         }
 
@@ -236 +242 @@
                         $topic_content,
                         $topic_url,
-                        $this->labels['receipt']
+                        // String may not have placeholders, ie. in the case of tags.
+                        sprintf( $this->labels['receipt'], $this->directory ? $this->directory->title() : '' )
                 );
 
                 return $message;
+        }
+
+        /**
+         * Replace the forum subscription subject/title with term-specific messaging.
+         *
+         * @param string $title The current title
+         * @param int $topic_id The topic id
+         */
+        public function replace_forum_subscription_mail_title( $title, $topic_id ) {
+                if ( $this->directory && $this->directory->title() ) {
+                        $blog_name = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );
+                        $topic_title = strip_tags( bbp_get_topic_title( $topic_id ) );
+
+                        // [WordPress.org] [Plugin Name] This is my threads
+                        $title = sprintf( '[%s] [%s] %s', $blog_name, $this->directory->title(), $topic_title );
+                }
+
+                return $title;
         }
 
@@ -281 +306 @@
                 // Replace topic-specific messaging with term subscription messaging.
                 add_filter( 'bbp_subscription_mail_message', array( $this, 'replace_topic_subscription_mail_message' ), 10, 3 );
+                add_filter( 'bbp_subscription_mail_title',   array( $this, 'replace_topic_subscription_mail_title' ), 10, 3 );
 
                 // Replace forum subscriber list with term subscribers, avoiding duplicates.
@@ -290 +316 @@
                 // Remove filters.
                 remove_filter( 'bbp_topic_subscription_user_ids', array( $this, 'add_term_subscribers_to_topic' ) );
-                remove_filter( 'bbp_subscription_mail_message', array( $this, 'replace_topic_subscription_mail_message' ), 10 );
+                remove_filter( 'bbp_subscription_mail_message',   array( $this, 'replace_topic_subscription_mail_message' ) );
+                remove_filter( 'bbp_subscription_mail_title',     array( $this, 'replace_topic_subscription_mail_title' ) );
         }
 
@@ -331 +358 @@
                         $reply_content,
                         $reply_url,
-                        $this->labels['receipt']
+                        // String may not have placeholders, ie. in the case of tags.
+                        sprintf( $this->labels['receipt'], $this->directory ? $this->directory->title() : '' )
                 );
 
                 return $message;
+        }
+
+        /**
+         * Replace the topic subscription subject/title with term-specific messaging.
+         *
+         * @param string $title    The current title
+         * @param int    $reply_id The reply id
+         * @param int    $topic_id The topic id
+         */
+        public function replace_topic_subscription_mail_title( $title, $reply_id, $topic_id ) {
+                if ( $this->directory && $this->directory->title() ) {
+                        $blog_name = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );
+                        $topic_title = strip_tags( bbp_get_topic_title( $topic_id ) );
+
+                        // [WordPress.org] [Plugin Name] This is my threads
+                        $title = sprintf( '[%s] [%s] %s', $blog_name, $this->directory->title(), $topic_title );
+                }
+
+                return $title;
         }