Changeset 14426

Timestamp:

04/16/2025 08:50:08 PM (18 months ago)

Author:

coffee2code

Message:

Photo Directory, Admin: Reimplement appending author column submission stats as a custom 'Author' column.

• Replaces existing 'Author' column.
• Renames add_published_photos_count_to_author to get_author_submission_stats().

Props mujuonly, nilovelez, otto42, coffee2code.

File:

• sites/trunk/wordpress.org/public_html/wp-content/plugins/photo-directory/inc/admin.php (modified) (13 diffs)

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

@@ -10 +10 @@
 class Admin {
 
+        const COL_NAME_AUTHOR = 'wporg-photo-author';
         const COL_NAME_FLAG  = 'wporg-flags';
         const COL_NAME_PHOTO = 'wporg-photo';
@@ -27 +28 @@
                 add_action( 'load-edit.php',                           [ __CLASS__, 'add_admin_css' ] );
                 add_action( 'load-post.php',                           [ __CLASS__, 'add_admin_css' ] );
+                add_filter( "manage_{$post_type}_posts_columns",       [ __CLASS__, 'add_author_column' ] );
+                add_action( "manage_{$post_type}_posts_custom_column", [ __CLASS__, 'handle_author_column_data' ], 10, 2 );
                 add_filter( "manage_{$post_type}_posts_columns",       [ __CLASS__, 'add_photo_column' ] );
                 add_action( "manage_{$post_type}_posts_custom_column", [ __CLASS__, 'handle_photo_column_data' ], 10, 2 );
@@ -33 +36 @@
                 add_filter( "manage_edit-{$post_type}_columns",        [ __CLASS__, 'remove_columns_from_pending_photos' ] );
                 add_filter( 'post_row_actions',                        [ __CLASS__, 'add_post_action_photo_links' ], 10, 2 );
-                add_filter( 'the_author',                              [ __CLASS__, 'add_published_photos_count_to_author' ] );
                 add_filter( 'use_block_editor_for_post_type',          [ __CLASS__, 'disable_block_editor' ], 10, 2 );
                 add_action( 'admin_notices',                           [ __CLASS__, 'add_notice_to_photo_media_if_pending' ] );
@@ -325 +327 @@
                         ( empty( $_GET['post_status'] ) || in_array( $_GET['post_status'], $post_statuses ) )
                 );
+        }
+
+        /**
+         * Replaces default 'Author' column with a custom 'Author' column that shows
+         * typical author column data as well as additional data.
+         *
+         * As of WP 6.8, it no longer easy to modify the existing 'Author' column to
+         * add more data, so this adds a custom column to replace the 'Author' column.
+         *
+         * @param  array $posts_columns Array of post column titles.
+         * @return array The $posts_columns array with the photo author column added.
+         */
+        public static function add_author_column( $posts_columns ) {
+                if ( ! self::should_include_photo_column() ) {
+                        return $posts_columns;
+                }
+
+                // Position after existing 'Author' column.
+                $pos = array_search( 'author', array_keys( $posts_columns ) );
+
+                if ( ! $pos ) {
+                        // Else, position the column after the 'Title' column (where 'Author' is normally located).
+                        $pos = array_search( 'title', array_keys( $posts_columns ) );
+                }
+
+                if ( $pos ) {
+                        $pos++;
+                        $posts_columns = array_slice( $posts_columns, 0, $pos, true )
+                                + [ self::COL_NAME_AUTHOR => __( 'Author', 'wporg-photos' ) ]
+                                + array_slice( $posts_columns, $pos, count( $posts_columns ) - 1, true );
+                } else {
+                        $posts_columns[ self::COL_NAME_AUTHOR ] = __( 'Author', 'wporg-photos' );
+                }
+
+                // Remove the existing 'Author' column.
+                unset( $posts_columns['author'] );
+
+                return $posts_columns;
+        }
+
+        /**
+         * Outputs the photo author column content for the post.
+         *
+         * @param string $column_name The name of the column.
+         * @param int    $post_id     The id of the post being displayed.
+         */
+        public static function handle_author_column_data( $column_name, $post_id ) {
+                if ( self::COL_NAME_AUTHOR !== $column_name ) {
+                        return;
+                }
+
+                $post = get_post( $post_id );
+
+                // Get the same 'Author' column content as generated by core.
+                $list_table = _get_list_table( 'WP_Posts_List_Table' );
+                $core_html = $list_table->column_author( $post );
+
+                /**
+                 * Fires before any photo author column content is output.
+                 *
+                 * @param WP_Post The post object.
+                 */
+                do_action( 'photo_author_column_data_start', $post );
+
+                // Output core's default author column data for this post.
+                echo $core_html;
+
+                /**
+                 * Fires after the default author column content is output.
+                 *
+                 * @param WP_Post The post object.
+                 */
+                do_action( 'photo_author_column_data_after_author', $post );
+
+                // Output author submission counts.
+                echo self::get_author_submission_stats( (int) get_post_field( 'post_author', $post_id ) );
+
+                /**
+                 * Fires at the end of the photo author column content.
+                 *
+                 * @param WP_Post The post object.
+                 */
+                do_action( 'photo_author_column_data_end', $post );
         }
 
@@ -808 +893 @@
 
         /**
-         * Appends the count of the published photos to author names in photo post
-         * listings.
-         *
-         * @param string $display_name The author's display name.
+         * Returns hyperlinked statistics on the author's submission counts (published,
+         * pending, rejected, etc) intended to be shown to moderators.
+         *
+         * @param int $author_id Author ID.
          * @return string
          */
-        public static function add_published_photos_count_to_author( $display_name ) {
-                global $authordata;
-
-                if ( ! is_admin() || ! self::should_include_photo_column( true ) ) {
-                        return $display_name;
-                }
-
-                // Close link to contributor's listing of photos.
-                $display_name .= '</a>';
-
+        public static function get_author_submission_stats( $author_id ) {
                 $post_type     = Registrations::get_post_type();
                 $reject_status = Rejection::get_post_status();
+                $stats_display = '';
 
                 // Show number of approved photos.
@@ -831 +908 @@
                         'post_type'   => $post_type,
                         'post_status' => 'publish',
-                        'author'      => $authordata->ID,
+                        'author'      => $author_id,
                 ], 'edit.php' );
-                $display_name .= '<div class="user-approved-count">'
+                $stats_display .= '<div class="user-approved-count">'
                 . sprintf(
                         __( 'Approved: <strong>%s</strong>', 'wporg-photos' ),
@@ -846 +923 @@
                                 'post_type'   => $post_type,
                                 'post_status' => 'publish',
-                                'author'      => $authordata->ID,
+                                'author'      => $author_id,
                         ], 'edit.php' );
-                        $display_name .= '<div class="user-approved-today-count">'
+                        $stats_display .= '<div class="user-approved-today-count">'
                                 . sprintf(
                                         __( '&#x21AA; (today): %s', 'wporg-photos' ),
@@ -862 +939 @@
                                 'post_type'   => $post_type,
                                 'post_status' => 'pending',
-                                'author'      => $authordata->ID,
+                                'author'      => $author_id,
                         ], 'edit.php' );
 
-                        $display_name .= '<div class="user-pending-count">'
+                        $stats_display .= '<div class="user-pending-count">'
                                 . sprintf(
                                         __( 'Pending: <strong>%s</strong>', 'wporg-photos' ),
@@ -874 +951 @@
 
                 // Show number of rejected photos.
-                $rejection_count = User::count_rejected_photos( $authordata->ID );
+                $rejection_count = User::count_rejected_photos( $author_id );
                 if ( $rejection_count ) {
                         $rejected_link = add_query_arg( [
                                 'post_type'   => $post_type,
                                 'post_status' => $reject_status,
-                                'author'      => $authordata->ID,
+                                'author'      => $author_id,
                         ], 'edit.php' );
-                        $display_name .= '<div class="user-rejected-count">'
+                        $stats_display .= '<div class="user-rejected-count">'
                                 . sprintf(
                                         /* translators: %s: Count of user rejections linked to listing of their rejections. */
@@ -896 +973 @@
                                 'post_type'   => $post_type,
                                 'post_status' => $reject_status,
-                                'author'      => $authordata->ID,
+                                'author'      => $author_id,
                         ], 'edit.php' );
-                        $display_name .= '<div class="user-rejected-today-count">'
+                        $stats_display .= '<div class="user-rejected-today-count">'
                                 . sprintf(
                                         __( '&#x21AA; (today): %s', 'wporg-photos' ),
@@ -906 +983 @@
                 }
 
-                // Prevent unbalanced tag.
-                $display_name .= '<a>';
-
-                return $display_name;
+                return $stats_display;
         }
 
@@ -1316 +1390 @@
          */
         public static function add_contributor_ip_column( $posts_columns ) {
-                $pos = array_search( 'author', array_keys( $posts_columns ) );
+                $pos = array_search( self::COL_NAME_AUTHOR, array_keys( $posts_columns ) );
 
                 if ( $pos ) {
@@ -1322 +1396 @@
                         $posts_columns = array_slice( $posts_columns, 0, $pos, true )
                                 + [ self::COL_NAME_CONTRIBUTOR_IP => __( 'Contributor IP', 'wporg-photos' ) ]
-                                + array_slice( $posts_columns, 3, count( $posts_columns ) - 1, true );
+                                + array_slice( $posts_columns, $pos, count( $posts_columns ) - 1, true );
                 } else {
                         $posts_columns[ self::COL_NAME_CONTRIBUTOR_IP ] = __( 'Contributor IP', 'wporg-photos' );