Ticket #1988: 1988.2.diff

src/includes/common/functions.php

@@ -300 +300 @@
 }
 
 /**
+ * Append 'pending=type' to query string if it's already there from referer.
+ *
+ * @since 2.6.0 bbPress (rXXXX)
+ *
+ * @param string $original_link Original Link to be modified.
+ * @param string $type          The type of object pending.
+ *
+ * @return string The link with 'pending=type' appended if necessary.
+ */
+function bbp_add_pending( $original_link = '', $type = '' ) {
+
+        // Appending the pending=type vars.
+        $link = add_query_arg( array( 'pending' => $type ), $original_link );
+
+        return apply_filters( 'bbp_add_pending', $link, $original_link );
+}
+
+/**
+ * Remove 'pending=type' from query string.
+ *
+ * @since 2.6.0 bbPress (rXXXX)
+ *
+ * @param string $original_link Original Link to be modified.
+ *
+ * @return string The link with 'pending=type' appended if necessary.
+ */
+function bbp_remove_pending( $original_link = '' ) {
+        return apply_filters( 'bbp_remove_pending', remove_query_arg( 'pending', $original_link ), $original_link );
+}
+
+/**
+ * If the pending query arg exists.
+ *
+ * @since 2.6.0 bbPress (rXXXX)
+ *
+ * @return bool Whether the pending query arg exists.
+ */
+function bbp_get_pending() {
+        $retval = ( isset( $_GET['pending'] ) && in_array( $_GET['pending'], array( 'forum', 'topic', 'reply' ), true ) );
+        return (bool) apply_filters( 'bbp_get_pending', $retval );
+}
+
+/**
  * Assist pagination by returning correct page number
  *
  * @since 2.0.0 bbPress (r2628)

src/includes/common/template.php

@@ -2493 +2493 @@
 /** Errors & Messages *********************************************************/
 
 /**
+ * Displays the pending forum/topic/reply notice.
+ *
+ * @since 2.6.0 bbPress (rXXXX)
+ *
+ * @return void
+ */
+function bbp_pending_notices() {
+
+        // Bail if we don't have a pending query arg.
+        if ( ! bbp_get_pending() ) {
+                return;
+        }
+
+        // Get the pending object type.
+        $type = sanitize_key( $_GET['pending'] );
+
+        // Set the notice text based on the object type.
+        switch ( $type ) {
+
+                case 'forum' :
+                        $notice_text = __( 'Your forum has been successfully submitted and is pending moderator approval.', 'bbpress' );
+                        break;
+
+                case 'topic' :
+                        $notice_text = __( 'Your topic has been successfully submitted and is pending moderator approval.', 'bbpress' );
+                        break;
+
+                case 'reply' :
+                        $notice_text = __( 'Your reply has been successfully submitted and is pending moderator approval.', 'bbpress' );
+                        break;
+
+                default :
+                        $notice_text = '';
+                        break;
+        }
+
+        // Filter notice text and bail if empty.
+        $notice_text = apply_filters( 'bbp_pending_notices', $notice_text, $type );
+        if ( empty( $notice_text ) ) {
+                return;
+        }
+
+        bbp_add_error( 'bbp_pending_notices', $notice_text, 'message' );
+}
+
+/**
  * Display possible errors & messages inside a template file
  *
  * @since 2.0.0 bbPress (r2688)

src/includes/core/actions.php

@@ -146 +146 @@
 // Notices (loaded after bbp_init for translations)
 add_action( 'bbp_head',             'bbp_login_notices'    );
 add_action( 'bbp_head',             'bbp_topic_notices'    );
+add_action( 'bbp_init',             'bbp_pending_notices'  );
 add_action( 'bbp_template_notices', 'bbp_template_notices' );
 
 // Always exclude private/hidden forums if needed

src/includes/forums/functions.php

@@ -343 +343 @@
                 // Get the forum URL
                 $redirect_url = bbp_get_forum_permalink( $forum_id, $redirect_to );
 
+                // Maybe add a 'pending=forum' query arg.
+                if ( $forum_data['post_status'] === bbp_get_pending_status_id() ) {
+                        $redirect_url = bbp_add_pending( $redirect_url, 'forum' );
+                }
+
                 // Add view all?
                 if ( bbp_get_view_all() || ! empty( $view_all ) ) {
 
@@ -627 +632 @@
                 // Get the forum URL
                 $forum_url = bbp_get_forum_permalink( $forum_id, $redirect_to );
 
+                // Maybe add a 'pending=forum' query arg.
+                if ( $forum_data['post_status'] === bbp_get_pending_status_id() ) {
+                        $forum_url = bbp_add_pending( $forum_url, 'forum' );
+                }
+
                 // Add view all?
                 if ( ! empty( $view_all ) ) {
                         $forum_url = bbp_add_view_all( $forum_url );

src/includes/replies/functions.php

@@ -482 +482 @@
                 // Get the reply URL
                 $reply_url = bbp_get_reply_url( $reply_id, $redirect_to );
 
+                // Maybe add a 'pending=reply' query arg.
+                if ( $reply_data['post_status'] === bbp_get_pending_status_id() ) {
+                        $reply_url = bbp_add_pending( $reply_url, 'reply' );
+                }
+
                 // Allow to be filtered
                 $reply_url = apply_filters( 'bbp_new_reply_redirect_to', $reply_url, $redirect_to, $reply_id );
 
@@ -788 +793 @@
                 // Get the reply URL
                 $reply_url = bbp_get_reply_url( $reply_id, $redirect_to );
 
+                // Maybe add a 'pending=reply' query arg.
+                if ( $reply_data['post_status'] === bbp_get_pending_status_id() ) {
+                        $reply_url = bbp_add_pending( $reply_url, 'reply' );
+                }
+
                 // Allow to be filtered
                 $reply_url = apply_filters( 'bbp_edit_reply_redirect_to', $reply_url, $redirect_to );
 

src/includes/topics/functions.php

@@ -433 +433 @@
                 // Get the topic URL
                 $redirect_url = bbp_get_topic_permalink( $topic_id, $redirect_to );
 
+                // Maybe add a 'pending=topic' query arg.
+                if ( $topic_data['post_status'] === bbp_get_pending_status_id() ) {
+                        $redirect_url = bbp_add_pending( $redirect_url, 'topic' );
+                }
+
                 // Add view all?
                 if ( bbp_get_view_all() || ! empty( $view_all ) ) {
 
@@ -808 +813 @@
                 // Get the topic URL
                 $topic_url = bbp_get_topic_permalink( $topic_id, $redirect_to );
 
+                // Maybe add a 'pending=topic' query arg.
+                if ( $topic_data['post_status'] === bbp_get_pending_status_id() ) {
+                        $topic_url = bbp_add_pending( $topic_url, 'topic' );
+                }
+
                 // Add view all?
                 if ( ! empty( $view_all ) ) {
                         $topic_url = bbp_add_view_all( $topic_url );