Changeset 12535

Timestamp:

01/20/2020 06:58:31 PM (5 years ago)

Author:

imath

Message:

Core: fix PHP Code standards in inline comments

props passoniate

Fixes #8217

File:

• trunk/src/class-buddypress.php (modified) (19 diffs)

trunk/src/class-buddypress.php

@@ -114 +114 @@
     public static function instance() {
 
-        // Store the instance locally to avoid private static replication
+        // Store the instance locally to avoid private static replication.
         static $instance = null;
 
-        // Only run these methods if they haven't been run previously
+        // Only run these methods if they haven't been run previously.
         if ( null === $instance ) {
             $instance = new BuddyPress;
@@ -127 +127 @@
         }
 
-        // Always return the instance
+        // Always return the instance.
         return $instance;
 
@@ -227 +227 @@
         }
 
-        // Path and URL
+        // Path and URL.
         if ( ! defined( 'BP_PLUGIN_DIR' ) ) {
             define( 'BP_PLUGIN_DIR', plugin_dir_path( __FILE__ ) );
@@ -246 +246 @@
         }
 
-        // Only applicable to those running trunk
+        // Only applicable to those running trunk.
         if ( ! defined( 'BP_SOURCE_SUBDIRECTORY' ) ) {
             define( 'BP_SOURCE_SUBDIRECTORY', '' );
         }
 
-        // Define on which blog ID BuddyPress should run
+        // Define on which blog ID BuddyPress should run.
         if ( ! defined( 'BP_ROOT_BLOG' ) ) {
 
-            // Default to use current blog ID
-            // Fulfills non-network installs and BP_ENABLE_MULTIBLOG installs
+            // Default to use current blog ID.
+            // Fulfills non-network installs and BP_ENABLE_MULTIBLOG installs.
             $root_blog_id = get_current_blog_id();
 
-            // Multisite check
+            // Multisite check.
             if ( is_multisite() ) {
 
-                // Multiblog isn't enabled
+                // Multiblog isn't enabled.
                 if ( ! defined( 'BP_ENABLE_MULTIBLOG' ) || ( defined( 'BP_ENABLE_MULTIBLOG' ) && (int) constant( 'BP_ENABLE_MULTIBLOG' ) === 0 ) ) {
                     // Check to see if BP is network-activated
@@ -267 +267 @@
                     // /wp-admin/includes/plugin.php file in order to use that function.
 
-                    // get network-activated plugins
+                    // Get network-activated plugins.
                     $plugins = get_site_option( 'active_sitewide_plugins');
 
-                    // basename
+                    // Basename.
                     $basename = basename( constant( 'BP_PLUGIN_DIR' ) ) . '/bp-loader.php';
 
-                    // plugin is network-activated; use main site ID instead
+                    // Plugin is network-activated; use main site ID instead.
                     if ( isset( $plugins[ $basename ] ) ) {
                         $current_site = get_current_site();
@@ -286 +286 @@
 
         // The search slug has to be defined nice and early because of the way
-        // search requests are loaded
+        // search requests are loaded.
         //
-        // @todo Make this better
+        // @todo Make this better.
         if ( ! defined( 'BP_SEARCH_SLUG' ) ) {
             define( 'BP_SEARCH_SLUG', 'search' );
@@ -372 +372 @@
         /** Paths**************************************************************/
 
-        // BuddyPress root directory
+        // BuddyPress root directory.
         $this->file           = constant( 'BP_PLUGIN_DIR' ) . 'bp-loader.php';
         $this->basename       = basename( constant( 'BP_PLUGIN_DIR' ) ) . '/bp-loader.php';
@@ -378 +378 @@
         $this->plugin_url     = trailingslashit( constant( 'BP_PLUGIN_URL' ) . constant( 'BP_SOURCE_SUBDIRECTORY' ) );
 
-        // Languages
+        // Languages.
         $this->lang_dir       = $this->plugin_dir . 'bp-languages';
 
-        // Templates (theme compatibility)
+        // Templates (theme compatibility).
         $this->themes_dir     = $this->plugin_dir . 'bp-templates';
         $this->themes_url     = $this->plugin_url . 'bp-templates';
 
-        // Themes (for bp-default)
+        // Themes (for bp-default).
         $this->old_themes_dir = $this->plugin_dir . 'bp-themes';
         $this->old_themes_url = $this->plugin_url . 'bp-themes';
@@ -391 +391 @@
         /** Theme Compat ******************************************************/
 
-        $this->theme_compat   = new stdClass(); // Base theme compatibility class
-        $this->filters        = new stdClass(); // Used when adding/removing filters
+        $this->theme_compat   = new stdClass(); // Base theme compatibility class.
+        $this->filters        = new stdClass(); // Used when adding/removing filters.
 
         /** Users *************************************************************/
@@ -430 +430 @@
     private function legacy_constants() {
 
-        // Define the BuddyPress version
+        // Define the BuddyPress version.
         if ( ! defined( 'BP_VERSION' ) ) {
             define( 'BP_VERSION', $this->version );
         }
 
-        // Define the database version
+        // Define the database version.
         if ( ! defined( 'BP_DB_VERSION' ) ) {
             define( 'BP_DB_VERSION', $this->db_version );
         }
 
-        // Define if deprecated functions should be ignored
+        // Define if deprecated functions should be ignored.
         if ( ! defined( 'BP_IGNORE_DEPRECATED' ) ) {
             define( 'BP_IGNORE_DEPRECATED', true );
@@ -458 +458 @@
         require( $this->plugin_dir . 'bp-core/bp-core-wpabstraction.php' );
 
-        // Setup the versions (after we include multisite abstraction above)
+        // Setup the versions (after we include multisite abstraction above).
         $this->versions();
 
         /** Update/Install ****************************************************/
 
-        // Theme compatibility
+        // Theme compatibility.
         require( $this->plugin_dir . 'bp-core/bp-core-template-loader.php'     );
         require( $this->plugin_dir . 'bp-core/bp-core-theme-compatibility.php' );
 
-        // Require all of the BuddyPress core libraries
+        // Require all of the BuddyPress core libraries.
         require( $this->plugin_dir . 'bp-core/bp-core-dependency.php'       );
         require( $this->plugin_dir . 'bp-core/bp-core-actions.php'          );
@@ -490 +490 @@
         require( $this->plugin_dir . 'bp-core/bp-core-rest-api.php'         );
 
-        // Maybe load deprecated functionality (this double negative is proof positive!)
+        // Maybe load deprecated functionality (this double negative is proof positive!).
         if ( ! bp_get_option( '_bp_ignore_deprecated_code', ! $this->load_deprecated ) ) {
             require( $this->plugin_dir . 'bp-core/deprecated/1.2.php' );
@@ -511 +511 @@
         }
 
-        // Load wp-cli module if PHP 5.4+
+        // Load wp-cli module if PHP 5.4+.
         if ( defined( 'WP_CLI' ) && file_exists( $this->plugin_dir . 'cli/wp-cli-bp.php' ) && version_compare( phpversion(), '5.4.0', '>=' ) ) {
             require( $this->plugin_dir . 'cli/wp-cli-bp.php' );
@@ -659 +659 @@
     private function setup_actions() {
 
-        // Add actions to plugin activation and deactivation hooks
+        // Add actions to plugin activation and deactivation hooks.
         add_action( 'activate_'   . $this->basename, 'bp_activation'   );
         add_action( 'deactivate_' . $this->basename, 'bp_deactivation' );
 
-        // If BuddyPress is being deactivated, do not add any actions
+        // If BuddyPress is being deactivated, do not add any actions.
         if ( bp_is_deactivation( $this->basename ) ) {
             return;
@@ -670 +670 @@
         // Array of BuddyPress core actions
         $actions = array(
-            'setup_theme',              // Setup the default theme compat
-            'setup_current_user',       // Setup currently logged in user
-            'register_post_types',      // Register post types
-            'register_post_statuses',   // Register post statuses
-            'register_taxonomies',      // Register taxonomies
-            'register_views',           // Register the views
-            'register_theme_directory', // Register the theme directory
-            'register_theme_packages',  // Register bundled theme packages (bp-themes)
-            'load_textdomain',          // Load textdomain
-            'add_rewrite_tags',         // Add rewrite tags
-            'generate_rewrite_rules'    // Generate rewrite rules
+            'setup_theme',              // Setup the default theme compat.
+            'setup_current_user',       // Setup currently logged in user.
+            'register_post_types',      // Register post types.
+            'register_post_statuses',   // Register post statuses.
+            'register_taxonomies',      // Register taxonomies.
+            'register_views',           // Register the views.
+            'register_theme_directory', // Register the theme directory.
+            'register_theme_packages',  // Register bundled theme packages (bp-themes).
+            'load_textdomain',          // Load textdomain.
+            'add_rewrite_tags',         // Add rewrite tags.
+            'generate_rewrite_rules'    // Generate rewrite rules.
         );
 
-        // Add the actions
+        // Add the actions.
         foreach( $actions as $class_action ) {
             if ( method_exists( $this, $class_action ) ) {
@@ -709 +709 @@
     private function versions() {
 
-        // Get the possible DB versions (boy is this gross)
+        // Get the possible DB versions (boy is this gross).
         $versions               = array();
         $versions['1.6-single'] = get_blog_option( $this->root_blog_id, '_bp_db_version' );
 
-        // 1.6-single exists, so trust it
+        // 1.6-single exists, so trust it.
         if ( !empty( $versions['1.6-single'] ) ) {
             $this->db_version_raw = (int) $versions['1.6-single'];
 
-        // If no 1.6-single exists, use the max of the others
+        // If no 1.6-single exists, use the max of the others.
         } else {
             $versions['1.2']        = get_site_option(                      'bp-core-db-version' );
@@ -724 +724 @@
             $versions['1.5-single'] = get_blog_option( $this->root_blog_id,      'bp-db-version' );
 
-            // Remove empty array items
+            // Remove empty array items.
             $versions             = array_filter( $versions );
             $this->db_version_raw = (int) ( !empty( $versions ) ) ? (int) max( $versions ) : 0;
@@ -765 +765 @@
     public function register_theme_packages() {
 
-        // Register the default theme compatibility package
+        // Register the default theme compatibility package.
         bp_register_theme_package( array(
             'id'      => 'legacy',
@@ -795 +795 @@
     public function setup_theme() {
 
-        // Bail if something already has this under control
+        // Bail if something already has this under control.
         if ( ! empty( $this->theme_compat->theme ) ) {
             return;
         }
 
-        // Setup the theme package to use for compatibility
+        // Setup the theme package to use for compatibility.
         bp_setup_theme_compat( bp_get_theme_package_id() );
     }