Recognize that get_defined_vars() takes unused parameters

[sybrew]

Code speaks a thousand words.

function some_function( $var_1 ) { // VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable

    $var_2 = get_something(); // VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable

    do_something( get_defined_vars() ); // this should negate above warnings.
}

[sirbrillig]

Wow, I somehow never knew about get_defined_vars() before. Thanks for brining this up!

So you're suggesting that if get_defined_vars() is called in a scope, it should disable all unused variable warnings within that scope. That does make sense in the sense that all variables in that scope are being read just by calling that function.

🤔 I'm trying to think of any risks with doing that. Do you have any real-world examples of that function being used that I could reference?

[sybrew]

Cheers 😄

Yea, Automattic doesn't seem too fond of that function. I don't know why 🤷‍♂; I only found one (convoluted) instance in Jetpack.

And yes, that's exactly what I'm suggesting!

Aside from the example provided above, I use it when passing variadic parameters to my file inclusion handler^*.

Here's a reference: https://github.com/sybrew/the-seo-framework/blob/9638de251d856937b135a57dd5d2d663e81a39b8/inc/classes/profile.class.php#L79-L102

The placement of the error is a bit odd in that reference, but that's a common issue with phpcs.

^* file inclusions from an object method will also pass $this, and make the object accessible in even the private scope, but that's a story for another issue.