Update wp_dropdown_users( $args = '' ) to support a proper select option value HTML attribute

anon66243189 · September 9, 2021, 11:36am

Context

Maybe because WordPress does not like to consider its users (pun intended) it also neglects its functions that deal with “users”.

So for example the wp_dropdown_users( $args = '' ) function produces a select with all users, but it does not let you change the value of those select options

I am not sure why this feature was omitted, but as said, maybe it has to do with WP and Users not being on a nice path anyway

I amended that function in my plugins already quite some time ago as I need a customisable value attribute in the select option.
The change simply adds one new argument:

@type string $value_field User `data` object values to use as selection option **value**. Accepts any User `data` object property. Default to user ID.

BTW, this is already done in core’s wp_dropdown_categories, so there is no reason not to do it in wp_dropdown_users() as well.

Will you be able to help with the implementation?

Already done, just need to PR it.

If you do not want to waste votes also a comment will do for me.

viktor · September 9, 2021, 1:53pm

Voted, sounds like a good modification to the function.

james · September 9, 2021, 5:35pm

Same as the other two petitions of this type, add a new parameter to $args rather than to the function itself, and this can go in as soon as there’s a PR for it

anon66243189 · September 10, 2021, 4:50am

PR

github.com/ClassicPress/ClassicPress

Add multiple and value field arguments to wp_dropdown_users

ClassicPress:develop ← smileBeda:patch-4

opened 04:49AM - 10 Sep 21 UTC

smileBeda

+230 -13

## Description Add a `multiple` and a `value_field` argument to the $args array…, so to allow the User Dropdown to be a multiple select, and to control the select option `value` attribute. This change will allow a developer to instantiate the `wp_dropdown_users` function as a Multiple Select Dropdown instead of just as as single select. It also allows to control the `value` value of the `option` in the select dropdown, which by default is the User ID, and that is not only limited, but most of the times, undesired. Example usage `wp_dropdown_users( array( 'value_field' => 'user_login', 'multiple' => 'multiple' ) );` See also https://forums.classicpress.net/t/update-wp-dropdown-users-args-to-support-a-proper-select-option-value-html-attribute/ ## Motivation and context Often it is required to create multiple selects for Users - just google the question to see it pops up quite often. Controlling the value of a select is just a must, and pendant wp_dropdown_category already has that, so why not also add it to users? I use this a lot and replaced the function in my plugins... it's time to add it to core :) Additionally - this function is a _mess_, and sometimes also unsafe, so it needs more work. But for starters it should be complete, and useful. This change makes a first step in that direction. Later on, we need to make sure things are sanitised/escaped adequately, which currently they are only in display values, not in attribute values, which is just bad. However it has been like that for years, thus first I think we should complete the function with the missing arguments (this commit should do that). Later we can think about escaping and sanitising this better. ## How has this been tested? In my plugins, as well as local test of current PR. ## Screenshots ### Before <img width="1193" alt="Screenshot 2021-09-10 at 11 48 24" src="https://user-images.githubusercontent.com/11800236/132801279-fcbc6a69-3bae-421f-941d-4806e2431c95.png"> ### After <img width="1131" alt="Screenshot 2021-09-10 at 11 48 36" src="https://user-images.githubusercontent.com/11800236/132801291-e690b6da-9821-4e9e-832a-66291807e6c6.png"> ## Types of changes - New Feature (non invasive, backwards compatible)

viktor · September 10, 2021, 6:19am

Great job @anon66243189. Since this petition has a pull request now, I’ve updated its status and will set it to close to release votes. Any discussions related to PR should be done on GitHub.

viktor · September 15, 2021, 6:20am

This topic was automatically closed after 5 days. New replies are no longer allowed.