Changeset 14103

Timestamp:

10/09/2024 10:22:13 PM (4 months ago)

Author:

coffee2code

Message:

Photo Directory, Rejection: Create admin dashboard widget for simple rejection stats.

• Register and display the "Rejection Stats" admin dashboard widget
• Create count_rejections_per_reason() to return a count of rejections for each reason type.
• Change get_rejection_reasons() to exclude the approval item as a rejection reason by default. It only applies to the dropdown.

Fixes #7796.

Location:

sites/trunk/wordpress.org/public_html/wp-content/plugins/photo-directory

Files:

• assets/css/admin.css (modified) (1 diff)
• inc/rejection.php (modified) (5 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/photo-directory/assets/css/admin.css

@@ -158 +158 @@
     overflow-wrap: anywhere;
 }
+
+#dashboard-photo-rejection-stats .col-num {
+    width: 50px;
+}
+#dashboard-photo-rejection-stats .row-sum {
+    font-weight: bold;
+}
+#dashboard-photo-rejection-stats .row-sum td {
+    border-top: 1px solid #c3c4c7;
+}

sites/trunk/wordpress.org/public_html/wp-content/plugins/photo-directory/inc/rejection.php

@@ -169 +169 @@
         // Use JS to inject rejected post status into post submit box.
         add_action( 'admin_footer',                            [ __CLASS__, 'output_js_to_modify_post_status_in_submitbox_dropdown' ] );
+
+        // Register dashboard widget.
+        add_action( 'wp_dashboard_setup',                      [ __CLASS__, 'dashboard_setup' ] );
     }
 
@@ -311 +314 @@
      *                       is the specific attribute of the reason to return.
      *                       Empty string returns all data for reason. Default ''.
+     * @param bool   $include_approval Optional. Should the approval entry (which is
+     *                       technically not a rejection) be included? Default false.
      * @return array|string
      */
-    public static function get_rejection_reasons( $reason = '', $field = '' ) {
+    public static function get_rejection_reasons( $reason = '', $field = '', $include_approval = false ) {
         // Return all reasons if one wasn't specified.
         if ( ! $reason ) {
             $reasons = self::$rejection_reasons;
+            if ( ! $include_approval ) {
+                unset( $reasons[''] );
+            }
             uasort( $reasons, function( $a, $b ) {
                 return strcmp( $a['label'], $b['label'] );
@@ -367 +375 @@
 
         return $rejection_reason;
+    }
+
+    /**
+     * Returns a count of rejections for each rejection reason.
+     *
+     * @return array Associate array of rejection reason keys and their respective rejection counts.
+     */
+    public static function count_rejections_per_reason() {
+        global $wpdb;
+
+        $reasons = self::get_rejection_reasons();
+        $reasons_keys = array_keys( $reasons );
+
+        $results = $wpdb->get_results( $wpdb->prepare(
+            "SELECT meta_value AS rejection_reason, COUNT(*) AS count FROM $wpdb->postmeta WHERE meta_key = %s GROUP BY meta_value",
+            'rejected_reason'
+        ) );
+
+        $return = [];
+        foreach ( $results as $row ) {
+            $return[ $row->rejection_reason ] = $row->count;
+        }
+
+        return $return;
     }
 
@@ -982 +1014 @@
             disabled( true, $is_disabled, false )
         );
-        foreach ( self::get_rejection_reasons() as $reason => $args ) {
+        foreach ( self::get_rejection_reasons( '', '', true ) as $reason => $args ) {
             printf(
                 '<option value="%s"%s>%s</option>' . "\n",
@@ -1304 +1336 @@
     }
 
+    /**
+     * Registers the admin dashboard.
+     */
+    public static function dashboard_setup() {
+        if ( current_user_can( 'edit_photos' ) ) {
+            wp_add_dashboard_widget(
+                'dashboard_photo_rejections',
+                __( 'Rejection Stats', 'wporg-photos' ),
+                [ __CLASS__, 'dashboard_photo_rejections' ],
+                null,
+                null,
+                'column3'
+            );
+        }
+    }
+
+    /**
+     * Outputs the photo rejection stats dashboard widget.
+     */
+    public static function dashboard_photo_rejections() {
+        echo '<div class="main">';
+
+        // Get list of all rejection types.
+        $rejection_reasons = self::get_rejection_reasons();
+        ksort( $rejection_reasons );
+        $rejection_reasons_counts = self::count_rejections_per_reason();
+
+        // Omit submission errors since they aren't true rejections.
+        unset( $rejection_reasons['submission-error'] );
+        unset( $rejection_reasons_counts['submission-error'] );
+
+        echo '<table id="dashboard-photo-rejection-stats" class="wp-list-table widefat fixed striped table-view-list">';
+        echo '<thead><tr>';
+        echo '<th>' . __( 'Rejection reason', 'wporg-photos' ) . '</th>';
+        echo '<th class="col-num col-num-rejected" title="' . esc_attr__( 'Number of photos rejected', 'wporg-photos' ) . '"><span class="dashicons dashicons-thumbs-down"></span></th>';
+        echo '<th class="col-num col-percent-rejected" title="' . esc_attr( 'Percentage of overall rejections', 'wporg-photos' ) . '">%</th>';
+        echo '</tr></thead>';
+        echo '<tbody>';
+
+        $total_rejections = array_sum( $rejection_reasons_counts );
+
+        foreach ( $rejection_reasons as $reason => $data ) {
+            $data['count'] = $rejection_reasons_counts[ $reason ];
+
+            echo '<tr>';
+            echo '<td title="' . esc_attr( $data['label'] ) . '">' . esc_html( $reason ) . '</td>';
+            echo '<td>' . number_format_i18n( $data['count'] ) . '</td>';
+            echo '<td>' . round( ( $data['count'] / $total_rejections ) * 100, 2 ) . '%</td>';
+            echo "</tr>\n";
+        }
+
+        echo '<tr class="row-sum"><td>' . __( 'Total', 'wporg-photos' ) . '</td><td>' . number_format_i18n( $total_rejections ) . '</td><td>100%</td></tr>';
+        echo '</tbody></table>';
+        echo '</div>';
+    }
+
 }