Changeset 4971

Timestamp:

05/28/2013 11:12:36 PM (12 years ago)

Author:

johnjamesjacoby

Message:

Allow the search feature to be toggled on and off. Introduces new setting and supporting function to get and override the option easily in third party plugins. Fixes #2342.

Location:

trunk

Files:

• includes/admin/settings.php (modified) (4 diffs)
• includes/common/shortcodes.php (modified) (2 diffs)
• includes/common/template-tags.php (modified) (2 diffs)
• includes/common/widgets.php (modified) (1 diff)
• includes/core/options.php (modified) (2 diffs)
• templates/default/bbpress/content-archive-forum.php (modified) (1 diff)
• templates/default/bbpress/content-archive-topic.php (modified) (1 diff)

trunk/includes/admin/settings.php

@@ -85 +85 @@
         /** User Section ******************************************************/
 
-        'bbp_settings_user' => array(
+        'bbp_settings_users' => array(
 
             // Edit lock setting
@@ -158 +158 @@
                 'title'             => __( 'Topic tags', 'bbpress' ),
                 'callback'          => 'bbp_admin_setting_callback_topic_tags',
+                'sanitize_callback' => 'intval',
+                'args'              => array()
+            ),
+
+            // Allow topic tags
+            '_bbp_allow_search' => array(
+                'title'             => __( 'Search', 'bbpress' ),
+                'callback'          => 'bbp_admin_setting_callback_search',
                 'sanitize_callback' => 'intval',
                 'args'              => array()
@@ -178 +186 @@
             ),
 
-            // Allow threadde replies
-            '_bbp_allow_threaded_replies' => array(
-                'sanitize_callback' => 'intval',
-                'args'              => array()
-            ),
-
             // Set reply threading level
             '_bbp_thread_replies_depth' => array(
                 'title'             => __( 'Reply Threading', 'bbpress' ),
                 'callback'          => 'bbp_admin_setting_callback_thread_replies_depth',
+                'sanitize_callback' => 'intval',
+                'args'              => array()
+            ),
+
+            // Allow threadde replies
+            '_bbp_allow_threaded_replies' => array(
                 'sanitize_callback' => 'intval',
                 'args'              => array()
@@ -588 +596 @@
     <input id="_bbp_allow_topic_tags" name="_bbp_allow_topic_tags" type="checkbox" id="_bbp_allow_topic_tags" value="1" <?php checked( bbp_allow_topic_tags( true ) ); bbp_maybe_admin_setting_disabled( '_bbp_allow_topic_tags' ); ?> />
     <label for="_bbp_allow_topic_tags"><?php esc_html_e( 'Allow topics to have tags', 'bbpress' ); ?></label>
+
+<?php
+}
+
+/**
+ * Allow forum wide search
+ *
+ * @since bbPress (r4970)
+ *
+ * @uses checked() To display the checked attribute
+ */
+function bbp_admin_setting_callback_search() {
+?>
+
+    <input id="_bbp_allow_search" name="_bbp_allow_search" type="checkbox" id="_bbp_allow_search" value="1" <?php checked( bbp_allow_search( true ) ); bbp_maybe_admin_setting_disabled( '_bbp_allow_search' ); ?> />
+    <label for="_bbp_allow_search"><?php esc_html_e( 'Allow forum wide search', 'bbpress' ); ?></label>
 
 <?php

trunk/includes/common/shortcodes.php

@@ -621 +621 @@
     public function display_search_form() {
 
+        // Bail if search is disabled
+        if ( ! bbp_allow_search() ) {
+            return;
+        }
+
         // Start output buffer
         $this->start( 'bbp_search_form' );
@@ -645 +650 @@
 
         // Sanity check required info
-        if ( !empty( $content ) )
+        if ( !empty( $content ) ) {
             return $content;
+        }
+
+        // Bail if search is disabled
+        if ( ! bbp_allow_search() ) {
+            return;
+        }
 
         // Trim search attribute if it's set

trunk/includes/common/template-tags.php

@@ -795 +795 @@
     global $wp_query;
 
+    // Bail if search is disabled
+    if ( ! bbp_allow_search() )
+        return false;
+
     // Assume false
     $retval = false;
@@ -824 +828 @@
 function bbp_is_search_results() {
     global $wp_query;
+
+    // Bail if search is disabled
+    if ( ! bbp_allow_search() )
+        return false;
 
     // Assume false

trunk/includes/common/widgets.php

@@ -408 +408 @@
      */
     public function widget( $args, $instance ) {
+
+        // Bail if search is disabled
+        if ( ! bbp_allow_search() )
+            return;
 
         // Get widget settings

trunk/includes/core/options.php

@@ -37 +37 @@
         '_bbp_allow_global_access'    => 1,                          // Users from all sites can post
         '_bbp_allow_revisions'        => 1,                          // Allow revisions
-        '_bbp_allow_topic_tags'       => 1,                          // Topic Tags
+        '_bbp_allow_topic_tags'       => 1,                          // Allow topic tagging
         '_bbp_allow_threaded_replies' => 0,                          // Allow threaded replies
+        '_bbp_allow_search'           => 1,                          // Allow forum-wide search
         '_bbp_thread_replies_depth'   => 2,                          // Thread replies depth
         '_bbp_use_wp_editor'          => 1,                          // Use the WordPress editor if available
@@ -228 +229 @@
 function bbp_allow_topic_tags( $default = 1 ) {
     return (bool) apply_filters( 'bbp_allow_topic_tags', (bool) get_option( '_bbp_allow_topic_tags', $default ) );
+}
+
+/**
+ * Is forum-wide searching allowed
+ *
+ * @since bbPress (r4970)
+ * @param $default bool Optional. Default value true
+ * @uses get_option() To get the forum-wide search setting
+ * @return bool Is forum-wide searching allowed?
+ */
+function bbp_allow_search( $default = 1 ) {
+    return (bool) apply_filters( 'bbp_allow_search', (bool) get_option( '_bbp_allow_search', $default ) );
 }
 

trunk/templates/default/bbpress/content-archive-forum.php

@@ -12 +12 @@
 <div id="bbpress-forums">
 
-    <div class="bbp-search-form">
+    <?php if ( bbp_allow_search() ) : ?>
 
-        <?php bbp_get_template_part( 'form', 'search' ); ?>
+        <div class="bbp-search-form">
 
-    </div>
+            <?php bbp_get_template_part( 'form', 'search' ); ?>
+
+        </div>
+
+    <?php endif; ?>
 
     <?php bbp_breadcrumb(); ?>

trunk/templates/default/bbpress/content-archive-topic.php

@@ -11 +11 @@
 
 <div id="bbpress-forums">
+
+    <?php if ( bbp_allow_search() ) : ?>
+
+        <div class="bbp-search-form">
+
+            <?php bbp_get_template_part( 'form', 'search' ); ?>
+
+        </div>
+
+    <?php endif; ?>
 
     <?php bbp_breadcrumb(); ?>