Unused parameter in function is_user_option_local

[bnap00]

function is_user_option_local has a parameter for accepting user ID, but is never used in the function.

[bnap00]

Also the function is not being used in the entire WordPress code base

[spacedmonkey]

We can't make this change as it would break backwards compatibility. If anyone is using the function is their plugin / theme, they maybe passing a null value there and using blog id.

I would recommend just fixing it, as it is really easy to fix.
There is a question around if we should just deprecate this function, but I would open another ticket to do that.

[bnap00]

@spacedmonkey I did not get your comment properly,
should we fix it or not?
if yes, what should be flow?

[flixos90]

I think instead of removing the parameter we should rather apply it correctly: If $user_id is passed, call get_user_by( 'id', $user_id ), otherwise stick with wp_get_current_user().

[spacedmonkey]

Fix it. Something like this should work.

function is_user_option_local( $key, $user_id = 0, $blog_id = 0 ) {
    global $wpdb;
    if ( $user_id && is_numeric( $user_id ) ) {
         $current_user = get_user_by( 'id', $user_id );
    } else{   
        $current_user = wp_get_current_user();
    }

[SergeyBiryukov]

Related: [28551]

[desrosj]

FWIW, this function is only called once in the entire .org plugin repository in the removed plugin, presstest.

[spacedmonkey]

41697-2.patch

Fixes the issue to me. I think it should be merged as a fix.

This function isn't used for anything, it should really be deprecated. @bnap00 do you want another ticket for deprecating this function.

[bnap00]

@spacedmonkey That would be great

[jeremyfelt]

We should just deprecate is_user_option_local() on this ticket without making any other changes. It was added in MU (see timeline below) and used for a handful of changesets before it the code using it was removed again. It never actually did anything with $user_id and always deferred to the current user.

• WordPress Admin Bar plugin added to MU trunk - ​https://mu.trac.wordpress.org/changeset/1584
• Additional code using is_user_option_local() added in the 2.7 branch of MU - ​https://mu.trac.wordpress.org/changeset/1735
• is_user_option_local() added to the 2.7 branch of MU - ​https://mu.trac.wordpress.org/changeset/1736
• WordPress Admin Bar plugin removed from 2.7 branch of MU - ​https://mu.trac.wordpress.org/changeset/1755
• is_user_option_local() added to MU trunk ​https://mu.trac.wordpress.org/changeset/1771
• The WordPress Admin Bar plugin removed from MU trunk ​https://mu.trac.wordpress.org/changeset/1772

[jeremyfelt]

In 41668:

Multisite: Deprecate is_user_option_local().

is_user_option_local() was added during MU development and used for a handful of changesets before the code using it was removed again. It has not been used by MU or core since nor is it widely used elsewhere.

Fixes #41697.
Props bnap00, jeremyfelt.