Changeset 4196

Timestamp:

10/07/2016 04:35:28 AM (10 years ago)

Author:

dd32

Message:

Plugin Directory: Readme Parsing: Standardise on user_nicename rather than user_login for the Contributors header.
On WordPress.org we've got a lot of accounts for which the Login contains spaces, uppercase characters, email addresses, etc. Standardising on user_nicename simplifies the rest of the code.

See #1724

File:

• sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme/class-parser.php (modified) (1 diff)

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme/class-parser.php

@@ -489 +489 @@
         protected function sanitize_contributors( $users ) {
                 foreach ( $users as $i => $name ) {
-                        if ( $user = get_user_by( 'login', $name ) ) {
-
-                                // Check the case of the user login matches.
-                                if ( $name !== $user->user_login ) {
-                                        $users[ $i ] = $user->user_login;
-                                }
-                        } elseif ( false !== ( $user = get_user_by( 'slug', $name ) ) ) {
-
-                                // Overwrite the nicename with the user_login.
-                                $users[ $i ] = $user->user_login;
-                        } else {
-
-                                // Unknown user, we'll skip these entirely to encourage correct readme files.
+                        // Contributors should be listed by their WordPress.org Login name (Example: 'Joe Bloggs')
+                        $user = get_user_by( 'login', $name );
+
+                        // Or failing that, by their user_nicename field (Example: 'joe-bloggs')
+                        if ( ! $user ) {
+                                $user = get_user_by( 'slug', $name );
+                        }
+
+                        // In the event that something invalid is used, we'll ignore it (Example: 'Joe Bloggs (Australian Translation)')
+                        if ( ! $user ) {
                                 unset( $users[ $i ] );
-                        }
+                                continue;
+                        }
+
+                        // Overwrite whatever the author has specified with the sanitized nicename.
+                        $users[ $i ] = $user->user_nicename;
                 }