User roles property should always be an array, but they sometimes become an object in localized data by haruncpi · Pull Request #8790 · WordPress/wordpress-develop

haruncpi · 2025-05-10T07:04:47Z

When filtering user roles using array_filter() by get_role_caps method in wp-includes/class-wp-user.php, the resulting $this->roles array can end up with non-sequential numeric keys if some roles are removed. This causes WP_User->roles to be treated as a JavaScript object instead of an array when passed through wp_localize_script() — breaking client-side expectations.

For example:

$current_user = wp_get_current_user();

$local_data = array(
    'current_user' => array(
        'id' => $current_user->ID,
        'roles' => $current_user->roles,
    ),
);

wp_localize_script( 'myplugin-frontend', '_myplugin_object', $local_data );

If roles contains keys like [0 => 'editor', 2 => 'custom'], the resulting JSON becomes:

{ roles: { "0": "editor", "2": "custom" } }

Instead of

{ roles: ["editor", "custom"] }

This patch fixes the issue by reindexing the array with array_values() to ensure the result is always a proper, sequential array.

Ticket’s URL
https://core.trac.wordpress.org/ticket/63427

github-actions · 2025-05-10T07:04:56Z

Hi @haruncpi! 👋

Thank you for your contribution to WordPress! 💖

It looks like this is your first pull request to wordpress-develop. Here are a few things to be aware of that may help you out!

No one monitors this repository for new pull requests. Pull requests must be attached to a Trac ticket to be considered for inclusion in WordPress Core. To attach a pull request to a Trac ticket, please include the ticket's full URL in your pull request description.

Pull requests are never merged on GitHub. The WordPress codebase continues to be managed through the SVN repository that this GitHub repository mirrors. Please feel free to open pull requests to work on any contribution you are making.

More information about how GitHub pull requests can be used to contribute to WordPress can be found in the Core Handbook.

Please include automated tests. Including tests in your pull request is one way to help your patch be considered faster. To learn about WordPress' test suites, visit the Automated Testing page in the handbook.

If you have not had a chance, please review the Contribute with Code page in the WordPress Core Handbook.

The Developer Hub also documents the various coding standards that are followed:

Thank you,
The WordPress Project

github-actions · 2025-05-10T07:04:58Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props haruncpi, peterwilsoncc, sirlouen, getsyash, wildworks.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

github-actions · 2025-05-10T07:17:56Z

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

The Plugin and Theme Directories cannot be accessed within Playground.
All changes will be lost when closing a tab with a Playground instance.
All changes will be lost when refreshing the page.
A fresh instance is created each time the link below is clicked.
Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

getsyash · 2025-05-10T15:45:49Z

Test Report

I’ve tested this PR and can confirm that it works as expected. After applying the changes, the $current_user->roles array is properly reindexed using array_values(), ensuring sequential keys. The localized JSON output now correctly produces an array instead of a JavaScript object, which resolves the client-side issue.

Tested with multiple role combinations, including cases where some roles were removed — everything behaves correctly. ✅

Testing environment:

WordPress Version: 6.8.1
PHP Version: 8.2.27
Theme: TwentyTwentyFive
Plugins: None installed
OS: Windows

Thanks for the Fix

src/wp-includes/class-wp-user.php

haruncpi · 2025-06-15T13:29:44Z

tests/phpunit/tests/user.php

 	 * @return void
 	 */
-	public function test_user_roles_property_should_be_reindexed() {
+	public function test_user_roles_property_is_sequential_array() {


This test case method is not from earlier code—it was specifically written for this PR and is directly related to ticket #63427. It’s safe and will not cause any breakage.

src/wp-includes/class-wp-user.php

peterwilsoncc

I've added some notes inline.

I've taken the liberty of merging trunk in to your branch, ignore the PHP 8.5 failures for now. Unrelated to this PR.

tests/phpunit/tests/user.php

peterwilsoncc · 2025-11-10T02:22:17Z

src/wp-includes/class-wp-user.php

+			$this->roles = array();
+			foreach ( $this->caps as $key => $value ) {
+				if ( $wp_roles->is_role( $key ) ) {
+					$this->roles[] = $key;
+				}
+			}


This could be simplified to use array_values() instead of a loop.

At the very first commit of this PR, I used an array_values() check this commit: 4e32ecf

However, that approach had a downside — chaining multiple array functions such as array_keys(), array_filter(), and array_values() increases both time complexity and memory usage. This can lead to unnecessary overhead, as each function call duplicates or re-indexes data.

Following feedback from @SirLouen , I replaced the chained array operations with a simple foreach loop. This improves code performance, reduces time complexity, and makes the logic easier to read and maintain.

You can see the related discussion in the commit linked above.

Are there numbers on the performance effect?

If a simpler approach can make the code a bit faster and cleaner, why not use it? Even small improvements like this contribute to making WordPress overall a little more performant.

In the previous version, with the addition of array_values(), each of the array functions (array_keys(), array_filter(), array_values()) creates a new array in memory. When these functions are chained, it results in:

Multiple iterations — each function loops through the array once.

Temporary arrays — each function returns a new array copy, increasing memory usage.

Re-indexing overhead — array_values() in particular reassigns numeric indexes, adding another full pass.

A simple foreach loop, by contrast:

Iterates only once.

Doesn’t duplicate or re-index data.

Keeps the logic in a single, predictable control flow.

…into trunk

t-hamano · 2025-11-10T08:07:48Z

@haruncpi It appears the unit tests are failing. Could you investigate whether the problem lies in the logic itself or if the tests need to be updated?

haruncpi · 2025-11-10T08:46:41Z

@t-hamano unit test case updated, now it's working fine.

github-actions · 2025-11-11T12:51:16Z

A commit was made that fixes the Trac ticket referenced in the description of this pull request.

SVN changeset: 61210
GitHub commit: 49b38e9

This PR will be closed, but please confirm the accuracy of this and reopen if there is more work to be done.

Adds array reindexing to ensure roles remains a proper indexed array

4e32ecf

haruncpi added 4 commits May 12, 2025 15:26

unit test added

6e53e6d

wpcs issue fix

3958cca

wpcs issue fix

db42295

wpcs reserved keyword array param changed to arr

70a0ad2

SirLouen suggested changes Jun 12, 2025

View reviewed changes

src/wp-includes/class-wp-user.php Outdated Show resolved Hide resolved

haruncpi added 2 commits June 15, 2025 13:29

Refactor: Improve performance of role filtering logic

d2cb3e0

Update: test method name updated and removed unnecessary comment.

2fe2fe8

haruncpi commented Jun 15, 2025

View reviewed changes

SirLouen suggested changes Jun 15, 2025

View reviewed changes

src/wp-includes/class-wp-user.php Outdated Show resolved Hide resolved

Update: foreach loop with key-value pairs in caps array

7fcc427

SirLouen approved these changes Jun 19, 2025

View reviewed changes

haruncpi and others added 2 commits November 1, 2025 20:01

Merge branch 'WordPress:trunk' into trunk

a0753b1

Merge branch 'trunk' into haruncpi/trunk

7c6213f

peterwilsoncc reviewed Nov 10, 2025

View reviewed changes

haruncpi added 5 commits November 10, 2025 12:18

removed @return void

01fba79

Merge branch 'trunk' of https://github.com/haruncpi/wordpress-develop …

9323c3e

…into trunk

ticket number removed from helper method

39fb17b

explained each assertion

3c3f459

improved doc comment of test helper

be680ac

haruncpi requested review from SirLouen and peterwilsoncc November 10, 2025 07:00

unit test case updated

8e155fd

converted to message param

cc0c584

JJJ approved these changes Nov 11, 2025

View reviewed changes

github-actions bot closed this Nov 11, 2025

Conversation

haruncpi commented May 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented May 10, 2025

Uh oh!

github-actions bot commented May 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented May 10, 2025

Test using WordPress Playground

Some things to be aware of

Uh oh!

getsyash commented May 10, 2025

Test Report

Testing environment:

Uh oh!

Uh oh!

haruncpi Jun 15, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

peterwilsoncc left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

peterwilsoncc Nov 10, 2025

Choose a reason for hiding this comment

Uh oh!

haruncpi Nov 10, 2025

Choose a reason for hiding this comment

Uh oh!

peterwilsoncc Nov 10, 2025

Choose a reason for hiding this comment

Uh oh!

haruncpi Nov 11, 2025

Choose a reason for hiding this comment

Uh oh!

t-hamano commented Nov 10, 2025

Uh oh!

haruncpi commented Nov 10, 2025

Uh oh!

github-actions bot commented Nov 11, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

haruncpi commented May 10, 2025 •

edited

Loading

github-actions bot commented May 10, 2025 •

edited

Loading

peterwilsoncc left a comment •

edited

Loading