Changeset 6772

Timestamp:

01/23/2018 11:26:56 PM (8 years ago)

Author:

johnjamesjacoby

Message:

Admin: enforce row-action order for forums, topics, and replies.

This change introduces a known (and filterable) sort-order to row-action keys, allowing for a more logical flow to better match Posts, Pages, and other WordPress core objects.

With slight variations, the flow is: Edit, Stick(to front), Un/approve, Open/Close, Delete/Trash, Spam, View.

Previous to this change, these row_actions() filters were only appending or overwriting keys, which introduced an unnecessary administration variation with no real benefit.

Location:

trunk/src/includes/admin

Files:

• forums.php (modified) (3 diffs)
• replies.php (modified) (3 diffs)
• topics.php (modified) (3 diffs)

trunk/src/includes/admin/forums.php

@@ -475 +475 @@
 
     /**
+     * Returns an array of keys used to sort row actions
+     *
+     * @since 2.6.0 bbPress (r6771)
+     *
+     * @return array
+     */
+    private function get_row_action_sort_order() {
+
+        // Filter & return
+        return (array) apply_filters( 'bbp_admin_forum_row_action_sort_order', array(
+            'edit',
+            'closed',
+            'trash',
+            'untrash',
+            'delete',
+            'view'
+        ) );
+    }
+
+    /**
      * Returns an array of notice toggles
      *
@@ -596 +616 @@
      * @since 2.0.0 bbPress (r2577)
      *
-     * @param array $actions Actions
-     * @param array $forum Forum object
+     * @param array  $actions Actions
+     * @param object $forum Topic object
+     *
      * @return array $actions Actions
      */
-    public function row_actions( $actions, $forum ) {
-
+    public function row_actions( $actions = array(), $forum = false ) {
+
+        // Disable quick edit (too much to do here)
         unset( $actions['inline hide-if-no-js'] );
 
@@ -621 +643 @@
         bbp_forum_content( $forum->ID );
 
-        return $actions;
+        // Sort & return
+        return $this->sort_row_actions( $actions );
+    }
+
+    /**
+     * Sort row actions by key
+     *
+     * @since 2.6.0
+     *
+     * @param array $actions
+     *
+     * @return array
+     */
+    private function sort_row_actions( $actions = array() ) {
+
+        // Return value
+        $retval = array();
+
+        // Known row actions, in sort order
+        $known_actions = $this->get_row_action_sort_order();
+
+        // Sort known actions, and keep any unknown ones
+        foreach ( $known_actions as $key ) {
+            if ( isset( $actions[ $key ] ) ) {
+                $retval[ $key ] = $actions[ $key ];
+                unset( $actions[ $key ] );
+            }
+        }
+
+        // Combine & return
+        return $retval + $actions;
     }
 

trunk/src/includes/admin/replies.php

@@ -596 +596 @@
 
     /**
+     * Returns an array of keys used to sort row actions
+     *
+     * @since 2.6.0 bbPress (r6771)
+     *
+     * @return array
+     */
+    private function get_row_action_sort_order() {
+
+        // Filter & return
+        return (array) apply_filters( 'bbp_admin_reply_row_action_sort_order', array(
+            'edit',
+            'approved',
+            'unapproved',
+            'spam',
+            'trash',
+            'untrash',
+            'delete',
+            'view'
+        ) );
+    }
+
+    /**
      * Returns an array of notice toggles
      *
@@ -754 +776 @@
      * @since 2.0.0 bbPress (r2577)
      *
-     * @param array $actions Actions
-     * @param array $reply Reply object
+     * @param array  $actions Actions
+     * @param object $reply Topic object
      *
      * @return array $actions Actions
      */
-    public function row_actions( $actions, $reply ) {
-
+    public function row_actions( $actions = array(), $reply = false ) {
+
+        // Disable quick edit (too much to do here)
         unset( $actions['inline hide-if-no-js'] );
 
@@ -819 +842 @@
         }
 
-        return $actions;
+        // Sort & return
+        return $this->sort_row_actions( $actions );
+    }
+
+    /**
+     * Sort row actions by key
+     *
+     * @since 2.6.0
+     *
+     * @param array $actions
+     *
+     * @return array
+     */
+    private function sort_row_actions( $actions = array() ) {
+
+        // Return value
+        $retval = array();
+
+        // Known row actions, in sort order
+        $known_actions = $this->get_row_action_sort_order();
+
+        // Sort known actions, and keep any unknown ones
+        foreach ( $known_actions as $key ) {
+            if ( isset( $actions[ $key ] ) ) {
+                $retval[ $key ] = $actions[ $key ];
+                unset( $actions[ $key ] );
+            }
+        }
+
+        // Combine & return
+        return $retval + $actions;
     }
 

trunk/src/includes/admin/topics.php

@@ -777 +777 @@
 
     /**
+     * Returns an array of keys used to sort row actions
+     *
+     * @since 2.6.0 bbPress (r6771)
+     *
+     * @return array
+     */
+    private function get_row_action_sort_order() {
+
+        // Filter & return
+        return (array) apply_filters( 'bbp_admin_topics_row_action_sort_order', array(
+            'edit',
+            'stick',
+            'approved',
+            'unapproved',
+            'closed',
+            'spam',
+            'trash',
+            'untrash',
+            'delete',
+            'view'
+        ) );
+    }
+
+    /**
      * Returns an array of notice toggles
      *
@@ -930 +954 @@
      * @since 2.0.0 bbPress (r2485)
      *
-     * @param array $actions Actions
-     * @param array $topic Topic object
+     * @param array  $actions Actions
+     * @param object $topic Topic object
+     *
      * @return array $actions Actions
      */
-    public function row_actions( $actions, $topic ) {
-
+    public function row_actions( $actions = array(), $topic = false ) {
+
+        // Disable quick edit (too much to do here)
         unset( $actions['inline hide-if-no-js'] );
 
@@ -1014 +1040 @@
         }
 
-        return $actions;
+        // Sort & return
+        return $this->sort_row_actions( $actions );
+    }
+
+    /**
+     * Sort row actions by key
+     *
+     * @since 2.6.0
+     *
+     * @param array $actions
+     *
+     * @return array
+     */
+    private function sort_row_actions( $actions = array() ) {
+
+        // Return value
+        $retval = array();
+
+        // Known row actions, in sort order
+        $known_actions = $this->get_row_action_sort_order();
+
+        // Sort known actions, and keep any unknown ones
+        foreach ( $known_actions as $key ) {
+            if ( isset( $actions[ $key ] ) ) {
+                $retval[ $key ] = $actions[ $key ];
+                unset( $actions[ $key ] );
+            }
+        }
+
+        // Combine & return
+        return $retval + $actions;
     }