Fix/facets order

[oscarssanchez]

Description of the Change

This PR fixes #2207

Currently, the problem seems to be https://github.com/10up/ElasticPress/blob/develop/includes/classes/Feature/Facets/Widget.php#L332 sorts alphabetically but doesn't have a logic to discern when ordering by count has been set. I'm adding two new optional parameters to the order_by_selected method so it accounts for this scenario.

Alternate Designs

Benefits

Possible Drawbacks

Verification Process

Checklist:

• I have read the CONTRIBUTING document.
• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have added tests to cover my change.
• All new and existing tests passed.

Applicable Issues

Changelog Entry

[Rahmon]

@oscarssanchez Maybe I'm missing something but it doesn't make sense to keep these ksort functions since we'll order the items late with uasort, right?

[oscarssanchez]

@Rahmon in this case i think it is worth keeping this when we are sorting by term name, but I forgot to account for ascending. I have added this here: 1b2c0a0 let me know your thoughts

[Rahmon]

@oscarssanchez When I'm trying to order by term name, the children terms are inverted.

For example setting this way Order Terms By: Term Name and Term Order: Descending, I have this:

1. Cursus
2. Consectetur
   1. xonsectetur children
   2. consectetur children

After selecting Consectetur (parent), the children appears that way:

1. Consectetur
   1. consectetur children
   2. xonsectetur children

The same occurs when I select Term Order: Ascending.

However, it's working for Order Terms By: Count.

[oscarssanchez]

Thanks @Rahmon i have updated this per our meeting to do the correct ordering.

[Rahmon]

LGTM 👍

[felipeelia]

@Rahmon @oscarssanchez before we merge this one, a couple of questions:

1. Are we fixing the problem for a +2 tree level? Like

Selected Term
   Child Term 1
     Grandchild Term 1
     Grandchild Term 2
   Child Term 2
Other term

2. It seems now we have two different functions ordering trees of terms: Utils\get_term_tree() and Facets/Widget::order_by_selected() . Did you explore the possibility of having only one of them?