Changeset 7380 for trunk/src/includes/admin/forums.php

Timestamp:

12/05/2025 02:27:53 AM (6 months ago)

Author:

johnjamesjacoby

Message:

Tools - Code Improvement: docs & code formatting improvements.

Props johnjamesjacoby, noruzzaman.

Fixes #3659.

File:

• trunk/src/includes/admin/forums.php (modified) (25 diffs)

trunk/src/includes/admin/forums.php

@@ -2 +2 @@
 
 /**
- * bbPress Forum Admin Class
+ * bbPress Forum Admin Class.
  *
  * @package bbPress
@@ -13 +13 @@
 if ( ! class_exists( 'BBP_Forums_Admin' ) ) :
 /**
- * Loads bbPress forums admin area
+ * Loads bbPress forums admin area.
  *
  * @package bbPress
@@ -24 +24 @@
 
     /**
-     * @var string The post type of this admin component
+     * @var string The post type of this admin component.
      */
     private $post_type = '';
@@ -31 +31 @@
 
     /**
-     * The main bbPress forums admin loader
+     * The main bbPress forums admin loader.
      *
      * @since 2.0.0 bbPress (r2515)
@@ -41 +41 @@
 
     /**
-     * Setup the admin hooks, actions and filters
+     * Setup the admin hooks, actions and filters.
      *
      * @since 2.0.0 bbPress (r2646)
@@ -77 +77 @@
 
     /**
-     * Admin globals
+     * Admin globals.
      *
      * @since 2.0.0 bbPress (r2646)
@@ -90 +90 @@
 
     /**
-     * Contextual help for bbPress forum edit page
+     * Contextual help for bbPress forum edit page.
      *
      * @since 2.0.0 bbPress (r3119)
@@ -157 +157 @@
 
     /**
-     * Contextual help for bbPress forum edit page
+     * Contextual help for bbPress forum edit page.
      *
      * @since 2.0.0 bbPress (r3119)
@@ -221 +221 @@
 
     /**
-     * Add the forum attributes meta-box
+     * Add the forum attributes meta-box.
      *
      * @since 2.0.0 bbPress (r2746)
@@ -237 +237 @@
 
     /**
-     * Add the forum moderators meta-box
+     * Add the forum moderators meta-box.
      *
      * @since 2.6.0 bbPress
@@ -260 +260 @@
 
     /**
-     * Add the subscriptions meta-box
+     * Add the subscriptions meta-box.
      *
      * Allows viewing of users who have subscribed to a forum.
@@ -290 +290 @@
 
     /**
-     * Remove comments & discussion meta-boxes if comments are not supported
+     * Remove comments & discussion meta-boxes if comments are not supported.
      *
      * @since 2.6.0 bbPress (r6186)
@@ -302 +302 @@
 
     /**
-     * Pass the forum attributes for processing
+     * Pass the forum attributes for processing.
      *
      * @since 2.0.0 bbPress (r2746)
      *
-     * @param int $forum_id Forum id
-     * @return int Forum id
+     * @param int $forum_id Forum id.
+     * @return int Forum id.
      */
     public function save_meta_boxes( $forum_id ) {
@@ -355 +355 @@
 
     /**
-     * Toggle forum
-     *
-     * Handles the admin-side opening/closing of forums
+     * Toggle forum.
+     *
+     * Handles the admin-side opening/closing of forums.
      *
      * @since 2.6.0 bbPress (r5254)
@@ -428 +428 @@
 
     /**
-     * Toggle forum notices
+     * Toggle forum notices.
      *
      * Display the success/error notices from
@@ -493 +493 @@
 
     /**
-     * Returns an array of keys used to sort row actions
+     * Returns an array of keys used to sort row actions.
      *
      * @since 2.6.0 bbPress (r6771)
@@ -522 +522 @@
 
     /**
-     * Returns an array of notice toggles
+     * Returns an array of notice toggles.
      *
      * @since 2.6.0 bbPress (r6396)
@@ -547 +547 @@
 
     /**
-     * Returns an array of notice toggles
+     * Returns an array of notice toggles.
      *
      * @since 2.6.0 bbPress (r6396)
@@ -571 +571 @@
 
     /**
-     * Manage the column headers for the forums page
+     * Manage the column headers for the forums page.
      *
      * @since 2.0.0 bbPress (r2485)
      *
-     * @param array $columns The columns
-     *
-     * @return array $columns bbPress forum columns
+     * @param array $columns The columns.
+     *
+     * @return array $columns bbPress forum columns.
      */
     public function column_headers( $columns ) {
@@ -609 +609 @@
 
     /**
-     * Print extra columns for the forums page
+     * Print extra columns for the forums page.
      *
      * @since 2.0.0 bbPress (r2485)
      *
-     * @param string $column Column
-     * @param int $forum_id Forum id
+     * @param string $column Column.
+     * @param int $forum_id Forum id.
      */
     public function column_data( $column, $forum_id ) {
@@ -664 +664 @@
 
     /**
-     * Forum Row actions
+     * Forum Row actions.
      *
      * Remove the quick-edit action link and display the description under
-     * the forum title and add the open/close links
+     * the forum title and add the open/close links.
      *
      * @since 2.0.0 bbPress (r2577)
      *
-     * @param array  $actions Actions
-     * @param object $forum   Forum object
-     *
-     * @return array $actions Actions
+     * @param array  $actions Actions.
+     * @param object $forum   Forum object.
+     *
+     * @return array $actions Actions.
      */
     public function row_actions( $actions = array(), $forum = false ) {
@@ -716 +716 @@
 
     /**
-     * Sort row actions by key
+     * Sort row actions by key.
      *
      * @since 2.6.0
      *
-     * @param array $actions
+     * @param array $actions.
      *
      * @return array
@@ -745 +745 @@
 
     /**
-     * Custom user feedback messages for forum post type
+     * Custom user feedback messages for forum post type.
      *
      * @since 2.0.0 bbPress (r3080)
@@ -838 +838 @@
 
 /**
- * Setup bbPress Forums Admin
+ * Setup bbPress Forums Admin.
  *
  * This is currently here to make hooking and unhooking of the admin UI easy.
@@ -845 +845 @@
  * @since 2.0.0 bbPress (r2596)
  *
- * @param WP_Screen $current_screen Current screen object
+ * @param WP_Screen $current_screen Current screen object.
  */
 function bbp_admin_forums( $current_screen ) {