Changeset 10183 for trunk/src/bp-forums/deprecated/1.7.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.7.php (modified) (9 diffs)

trunk/src/bp-forums/deprecated/1.7.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;
 
@@ -22 +21 @@
     $page  = bp_core_do_network_admin()  ? 'settings.php' : 'options-general.php';
 
-    // Add the administration tab under the "Site Admin" tab for site administrators
+    // Add the administration tab under the "Site Admin" tab for site administrators.
     $hook = add_submenu_page( $page, __( 'Forums', 'buddypress' ), __( 'Forums', 'buddypress' ), 'manage_options', 'bb-forums-setup', "bp_forums_bbpress_admin" );
 
-    // Fudge the highlighted subnav item when on the BuddyPress Forums admin page
+    // Fudge the highlighted subnav item when on the BuddyPress Forums admin page.
     add_action( "admin_head-$hook", 'bp_core_modify_admin_menu_highlight' );
 }
@@ -35 +34 @@
     check_admin_referer( 'bp_forums_existing_install_init' );
 
-    // Sanitize $_REQUEST['bbconfigloc']
+    // Sanitize $_REQUEST['bbconfigloc'].
     $_REQUEST['bbconfigloc'] = apply_filters( 'bp_forums_bbconfig_location', $_REQUEST['bbconfigloc'] );
 
@@ -65 +64 @@
     $bp = buddypress();
 
-    // Create the bb-config.php file
+    // Create the bb-config.php file.
     $initial_write = bp_forums_bbpress_write(
         $bp->plugin_dir . '/bp-forums/bbpress/bb-config-sample.php',
@@ -85 +84 @@
     );
 
-    // Add the custom user and usermeta entries to the config file
+    // Add the custom user and usermeta entries to the config file.
     if ( $initial_write == 1 ) {
         $file = file_get_contents( $location );
@@ -147 +146 @@
     }
 
-    // Get the existing lines in the file
+    // Get the existing lines in the file.
     $lines = file( $file_source );
 
-    // Initialise an array to store the modified lines
+    // Initialise an array to store the modified lines.
     $modified_lines = array();
 
-    // Loop through the lines and modify them
+    // Loop through the lines and modify them.
     foreach ( (array) $lines as $line ) {
         if ( isset( $alterations[substr( $line, 0, 20 )] ) ) {
@@ -184 +183 @@
     }
 
-    // Open the file for writing - rewrites the whole file
+    // Open the file for writing - rewrites the whole file.
     $file_handle = fopen( $file_target, 'w' );
 
-    // Write lines one by one to avoid OS specific newline hassles
+    // Write lines one by one to avoid OS specific newline hassles.
     foreach ( (array) $modified_lines as $modified_line ) {
         if ( strlen( $modified_line ) - 2 === strrpos( $modified_line, '?>' ) ) {
@@ -199 +198 @@
     }
 
-    // Close the config file
+    // Close the config file.
     fclose( $file_handle );