Setting help tab priorities fails to correctly order the tabs

[meitar]

When using the new WP_Screen::add_help_tab() feature of priorities, the docs suggest these priorities should be numeric. However, they are not correctly numerically sorted by priority. I had three help tabs with priorities 2, 10, and 40 but WP_Screen::get_help_tabs() returned them in the order 2, 40, 10.

I traced this problem to the way get_help_tabs() was resorting the tabs based on priority, which sorted the tabs by value rather than by their priority keys.

Using ksort() instead of sort() fixes this issue for me. A patch is attached.

[meitar]

Patch to use ksort() so help tab priorities are returned correctly ordered.

[meitar]

Seems this bug was introduced when help tab priority was introduced (changeset:34370)?

[swissspidy]

Yeah it looks like the priority sorting didn't work properly after [34370].

I just uploaded 35215.diff​ with updated unit tests that test the behaviour of adding three tabs with priorities of 2, 10 and 40. Without the change to ksort, the tabs are returned in incorrect order.

I also used assertSame in the unit test to make sure the types match all the time.

Moving this to the 4.4.1 milestone since it's a regression.

[jorbin]

In 36089:

Help Tab Order should be based on the Priority Argument

[34370] made the order that tabs are returned respect the order they are added, however it broke the respect of priority. By using a ksort instead of a sort, we can restore that default behavior. This adjusts the unit tests so that both order added and priority are tested.

Props meitar, swissspidy, jorbin
Fixes #35215. See #33941.

[dd32]

In 36104:

Help Tab Order should be based on the Priority Argument

[34370] made the order that tabs are returned respect the order they are added, however it broke the respect of priority. By using a ksort instead of a sort, we can restore that default behavior. This adjusts the unit tests so that both order added and priority are tested.

Merges [36089] to the 4.4 branch.
Props meitar, swissspidy, jorbin
Fixes #35215. See #33941.