DontExtractStandard.xml file creation

[aiolachiara]

Related to #1722

[GaryJones]

This line seems incomplete?

[aiolachiara]

you're right, I fixed the description of invalid code sample

[GaryJones]

Rather than giving a valid example as being "Use a similarly name function", I'd suggest demonstrating how to use keys from the $var_array directly. I'd also suggest renaming the variable to something a little more contextual.

$post_data = array(
    'title'   => 'My title',
    'content' => 'My content',
    'ID'      => 123
);
<em>echo $post_data['title'];</em>

The <em> </em> is used here as that's the bit we're emphasising. It should be added around the extract() call in the Invalid section too.

[jrfnl]

I agree with @GaryJones' remark here. The "Valid" example should show the correct way of doing it, not what's "tolerated" to prevent false positives.

When updating the code sample, please also update the "Valid" description.

[jrfnl]

@aiolachiara Thank you for working on this!

I agree with the remark @GaryJones left previously and have added a few more nitpick comments inline.

I look forward to seeing the next iteration of the PR!

[jrfnl]

Suggested change

	title="Don't exctract"
	title="Don't extract"

[jrfnl]

Suggested change

	Restricts the usage of `extract()` php function. It makes code harder to debug and harder to understand and may cause conflicts on variables names.
	Forbids the usage of the PHP native `extract()` function. Using `extract()` makes code harder to debug, harder to understand and may cause unexpected behaviour when variables names conflict.

[jrfnl]

Suggested change

	extract( $var_array, EXTR_OVERWRITE );
	extract( $var_array );

The second parameter is optional and rarely passed, so no need to include it in the example.

Another reason to remove it, is that it could be confusing to people - "but the example says it is only forbidden when used with EXTR_OVERWRITE...".

[jrfnl]

Suggested change

	$var_array = array(
	"title" => "My title",
	"content" => "My content",
	"ID" => 123
	);
	$var_array = array(
	'title' => 'My title',
	'content' => 'My content',
	'ID' => 123
	);

The code samples should comply with WPCS (aside from the issue being demonstrated). WPCS would flag the unnecessary use of double quotes here.

[jrfnl]

Suggested change

	<code title="Invalid: use `extract()` function">
	<code title="Invalid: Using the `extract()` function.">

[jrfnl]

I agree with @GaryJones' remark here. The "Valid" example should show the correct way of doing it, not what's "tolerated" to prevent false positives.

When updating the code sample, please also update the "Valid" description.