Changeset 10183 for trunk/src/bp-forums/deprecated/1.6.php

Timestamp:

10/04/2015 07:29:24 AM (9 years ago)

Author:

tw2113

Message:

Initial documentation cleanup for the BP Forums Component.

See #6397.

File:

• trunk/src/bp-forums/deprecated/1.6.php (modified) (7 diffs)

trunk/src/bp-forums/deprecated/1.6.php

@@ -1 +1 @@
 <?php
-
 /**
- * BuddyPress Forums Deprecated Functions
+ * BuddyPress Forums Deprecated Functions.
  *
  * This file contains all the deprecated functions for BuddyPress forums since
@@ -12 +11 @@
  */
 
-// Exit if accessed directly
+// Exit if accessed directly.
 defined( 'ABSPATH' ) || exit;
 
@@ -21 +20 @@
 
     // The text and URL of the Site Wide Forums button differs depending on whether bbPress
-    // is running
+    // is running.
     if ( is_plugin_active( 'bbpress/bbpress.php' ) ) {
         // The bbPress admin page will always be on the root blog. switch_to_blog() will
@@ -54 +53 @@
         if ( isset( $_REQUEST['reinstall'] ) || !bp_forums_is_installed_correctly() ) :
 
-            // Delete the bb-config.php location option
+            // Delete the bb-config.php location option.
             bp_delete_option( 'bb-config-location' );
 
-            // Now delete the bb-config.php file
+            // Now delete the bb-config.php file.
             @unlink( ABSPATH . 'bb-config.php' );
 
-            // show the updated wizard
+            // Show the updated wizard.
             bp_forums_bbpress_install_wizard();
 
@@ -121 +120 @@
 
     // The text and URL of the Site Wide Forums button differs depending on whether bbPress
-    // is running
+    // is running.
     if ( is_plugin_active( 'bbpress/bbpress.php' ) ) {
         $bbpress_plugin_is_active = true;
@@ -172 +171 @@
                         break;
                     default:
-                        // Just write the contents to screen
+                        // Just write the contents to screen.
                         _e( '<p>A configuration file could not be created. No problem, but you will need to save the text shown below into a file named <code>bb-config.php</code> in the root directory of your WordPress installation before you can start using the forum functionality.</p>', 'buddypress' ); ?>
 
@@ -200 +199 @@
             <?php } else {
 
-                // Include the plugin install
-
+                // Include the plugin install.
                 add_thickbox();
                 wp_enqueue_script( 'plugin-install' );