Changeset 7278

Timestamp:

07/02/2024 06:19:31 PM (9 months ago)

Author:

johnjamesjacoby

Message:

Admin: add post-state support to admin-area list-tables

This change checks posts for shortcode usages and adds "state" labels for them, to help make Forum integration easier to identify from within the list table context (usually Pages, but currently not post-type specific).

It does this by introducing BBP_Admin::display_post_states() and hooking it in as a filter to display_post_states.

Committer note: get_page_by_path() would offer more precision but also be significantly more costly to call here, so instead there is a fuzzy match on post_name for the Forum & Topic Archive pages only.

Fixes #3605.

File:

• trunk/src/includes/admin/classes/class-bbp-admin.php (modified) (2 diffs)

trunk/src/includes/admin/classes/class-bbp-admin.php

@@ -219 +219 @@
         // Allow keymasters to save forums settings
         add_filter( 'option_page_capability_bbpress',  array( $this, 'option_page_capability_bbpress' ) );
+
+        // Maybe add post-state support for Forum & Topic Archive pages
+        add_filter( 'display_post_states', array( $this, 'display_post_states' ), 10, 2 );
 
         /** Network Admin *****************************************************/
@@ -908 +911 @@
         $capability = $this->minimum_capability;
         return $capability;
+    }
+
+    /**
+     * Add post-state support for shortcode usages.
+     *
+     * Also does a quick slug comparison, to avoid doing many get_page_by_path()
+     * calls inside of a list-table loop. This is less precise but should work
+     * well-enough for most installations.
+     *
+     * @since 2.7.0
+     *
+     * @param array       $post_states
+     * @param int|WP_Post $post
+     *
+     * @return array
+     */
+    public function display_post_states( $post_states = array(), $post = 0 ) {
+
+        // Default return value
+        $retval = $post_states;
+
+        /** Shortcodes ********************************************************/
+
+        // Forum Archive
+        if ( has_shortcode( $post->post_content, 'bbp-forum-index' ) ) {
+            $retval[] = esc_html_x( 'Forum Archive', 'page label', 'bbpress' );
+
+        // Topic Archive
+        } elseif ( has_shortcode( $post->post_content, 'bbp-topic-index' ) ) {
+            $retval[] = esc_html_x( 'Topic Archive', 'page label', 'bbpress' );
+
+        // Topic Tags
+        } elseif ( has_shortcode( $post->post_content, 'bbp-topic-tags' ) ) {
+            $retval[] = esc_html_x( 'Topic Tags', 'page label', 'bbpress' );
+
+        // Topic View
+        } elseif ( has_shortcode( $post->post_content, 'bbp-single-view' ) ) {
+            $retval[] = esc_html_x( 'Topic View', 'page label', 'bbpress' );
+
+        // Search
+        } elseif ( has_shortcode( $post->post_content, 'bbp-search' ) ) {
+            $retval[] = esc_html_x( 'Forum Search', 'page label', 'bbpress' );
+
+        // Login
+        } elseif ( has_shortcode( $post->post_content, 'bbp-login' ) ) {
+            $retval[] = esc_html_x( 'Forum Login', 'page label', 'bbpress' );
+
+        // Register
+        } elseif ( has_shortcode( $post->post_content, 'bbp-register' ) ) {
+            $retval[] = esc_html_x( 'Forum Registration', 'page label', 'bbpress' );
+
+        // Lost Password
+        } elseif ( has_shortcode( $post->post_content, 'bbp-lost-pass' ) ) {
+            $retval[] = esc_html_x( 'Forum Lost Password', 'page label', 'bbpress' );
+
+        // Statistics
+        } elseif ( has_shortcode( $post->post_content, 'bbp-stats' ) ) {
+            $retval[] = esc_html_x( 'Forum Statistics', 'page label', 'bbpress' );
+
+        /** Paths *************************************************************/
+
+        // Forum Archive
+        } elseif ( $post->post_name === bbp_get_root_slug() ) {
+            $retval[] = esc_html_x( 'Forum Archive', 'page label', 'bbpress' );
+
+        // Topic Archive
+        } elseif ( $post->post_name === bbp_get_topic_archive_slug() ) {
+            $retval[] = esc_html_x( 'Topic Archive', 'page label', 'bbpress' );
+        }
+
+        // Return possibly modified post states
+        return $retval;
     }