Changeset 13937

Timestamp:

06/24/2024 05:29:42 PM (6 months ago)

Author:

imath

Message:

Manage BP specific WP List Tables pagination from a central function

• Introduces bp_admin_set_screen_options() to deal with WP List Table pagination

for Activity, Groups, Opt-outs & Site Invitations.

• Deprecates bp_activity_admin_screen_options() & bp_groups_admin_screen_options().

Props emaralive

Fixes #9195
Closes ​https://github.com/buddypress/buddypress/pull/320

Location:

trunk/src

Files:

• bp-activity/bp-activity-admin.php (modified) (2 diffs)
• bp-core/admin/bp-core-admin-functions.php (modified) (1 diff)
• bp-core/deprecated/14.0.php (modified) (1 diff)
• bp-groups/bp-groups-admin.php (modified) (2 diffs)

trunk/src/bp-activity/bp-activity-admin.php

@@ -15 +15 @@
 
 // Include WP's list table class.
-if ( ! class_exists( 'WP_List_Table' ) ) require( ABSPATH . 'wp-admin/includes/class-wp-list-table.php' );
-
-// Per_page screen option. Has to be hooked in extremely early.
-if ( is_admin() && ! empty( $_REQUEST['page'] ) && 'bp-activity' == $_REQUEST['page'] ) {
-    add_filter( 'set-screen-option', 'bp_activity_admin_screen_options', 10, 3 );
+if ( ! class_exists( 'WP_List_Table' ) ) {
+    require ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
 }
 
@@ -139 +136 @@
 }
 add_action( 'wp_ajax_bp-activity-admin-reply', 'bp_activity_admin_reply' );
-
-/**
- * Handle save/update of screen options for the Activity component admin screen.
- *
- * @since 1.6.0
- *
- * @param string $value     Will always be false unless another plugin filters it first.
- * @param string $option    Screen option name.
- * @param string $new_value Screen option form value.
- * @return string|int Option value. False to abandon update.
- */
-function bp_activity_admin_screen_options( $value, $option, $new_value ) {
-    if ( 'toplevel_page_bp_activity_per_page' != $option && 'toplevel_page_bp_activity_network_per_page' != $option )
-        return $value;
-
-    // Per page.
-    $new_value = (int) $new_value;
-    if ( $new_value < 1 || $new_value > 999 )
-        return $value;
-
-    return $new_value;
-}
 
 /**

trunk/src/bp-core/admin/bp-core-admin-functions.php

@@ -1700 +1700 @@
     <?php
 }
+
+/**
+ * Sets the "per page" screen option for BP Items WP Admin lists.
+ *
+ * @since 14.0.0
+ *
+ * @param bool   $value     Will always be false unless another plugin filters it first.
+ * @param string $option    Screen option name.
+ * @param string $new_value Screen option form value.
+ * @return string|int Option value. False to abandon update.
+ */
+function bp_admin_set_screen_options( $value, $option, $new_value ) {
+    // Sanitize the new value.
+    $new_value = (int) $new_value;
+
+    // Make sure it's a reasonable value to paginate results.
+    if ( $new_value < 1 || $new_value > 999 ) {
+        return $value;
+    }
+
+    return $new_value;
+}
+add_filter( 'set_screen_option_toplevel_page_bp_activity_per_page', 'bp_admin_set_screen_options', 10, 3 );
+add_filter( 'set_screen_option_toplevel_page_bp_activity_network_per_page', 'bp_admin_set_screen_options', 10, 3 );
+add_filter( 'set_screen_option_toplevel_page_bp_groups_per_page', 'bp_admin_set_screen_options', 10, 3 );
+add_filter( 'set_screen_option_toplevel_page_bp_groups_network_per_page', 'bp_admin_set_screen_options', 10, 3 );
+add_filter( 'set_screen_option_tools_page_bp_optouts_per_page', 'bp_admin_set_screen_options', 10, 3 );
+add_filter( 'set_screen_option_tools_page_bp_optouts_network_per_page', 'bp_admin_set_screen_options', 10, 3 );
+add_filter( 'set_screen_option_tools_page_bp_members_invitations_per_page', 'bp_admin_set_screen_options', 10, 3 );
+add_filter( 'set_screen_option_tools_page_bp_members_invitations_network_per_page', 'bp_admin_set_screen_options', 10, 3 );

trunk/src/bp-core/deprecated/14.0.php

@@ -99 +99 @@
     return false;
 }
+
+/**
+ * Handle save/update of screen options for the Activity component admin screen.
+ *
+ * @since 1.6.0
+ * @deprecated 14.0.0
+ *
+ * @param string $value     Will always be false unless another plugin filters it first.
+ * @param string $option    Screen option name.
+ * @param string $new_value Screen option form value.
+ * @return string|int Option value. False to abandon update.
+ */
+function bp_activity_admin_screen_options( $value, $option, $new_value ) {
+    _deprecated_function( __FUNCTION__, '14.0.0', 'bp_admin_set_screen_options' );
+
+    return bp_admin_set_screen_options( $value, $option, $new_value );
+}
+
+/**
+ * Handle save/update of screen options for the Groups component admin screen.
+ *
+ * @since 1.7.0
+ * @deprecated 14.0.0
+ *
+ * @param string $value     Will always be false unless another plugin filters it first.
+ * @param string $option    Screen option name.
+ * @param string $new_value Screen option form value.
+ * @return string|int Option value. False to abandon update.
+ */
+function bp_groups_admin_screen_options( $value, $option, $new_value ) {
+    _deprecated_function( __FUNCTION__, '14.0.0', 'bp_admin_set_screen_options' );
+
+    return bp_admin_set_screen_options( $value, $option, $new_value );
+}

trunk/src/bp-groups/bp-groups-admin.php

@@ -17 +17 @@
 if ( ! class_exists( 'WP_List_Table' ) ) {
     require ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
-}
-
-// The per_page screen option. Has to be hooked in extremely early.
-if ( is_admin() && ! empty( $_REQUEST['page'] ) && 'bp-groups' == $_REQUEST['page'] ) {
-    add_filter( 'set-screen-option', 'bp_groups_admin_screen_options', 10, 3 );
 }
 
@@ -525 +520 @@
 
 /**
- * Handle save/update of screen options for the Groups component admin screen.
- *
- * @since 1.7.0
- *
- * @param string $value     Will always be false unless another plugin filters it first.
- * @param string $option    Screen option name.
- * @param string $new_value Screen option form value.
- * @return string|int Option value. False to abandon update.
- */
-function bp_groups_admin_screen_options( $value, $option, $new_value ) {
-    if ( 'toplevel_page_bp_groups_per_page' != $option && 'toplevel_page_bp_groups_network_per_page' != $option ) {
-        return $value;
-    }
-
-    // Per page.
-    $new_value = (int) $new_value;
-    if ( $new_value < 1 || $new_value > 999 ) {
-        return $value;
-    }
-
-    return $new_value;
-}
-
-/**
  * Select the appropriate Groups admin screen, and output it.
  *