Incorrect example for WP_HTML_Tag_Processor class

[atachibana]

This issue was originally reported as ​https://github.com/WordPress/Documentation-Issue-Tracker/issues/1362.

The examples in the documentation reference:
​https://developer.wordpress.org/reference/classes/wp_html_tag_processor/#modifying-html-attributes-for-a-found-tag
using the class parameter to query for an existing class on a tag. But the source code and code function documentation actually only support the class_name property:
The example under Modifying HTML attributes for a found tag should be:

if ( $tags->next_tag( array( 'class_name' => 'wp-group-block' ) ) ) {

At least for me in WP 6.3.

Reported by @gaambo via User Contributed Notes.

Trac ticket: Core-59891
Resolves: ​https://github.com/WordPress/Documentation-Issue-Tracker/issues/1362

The example code in the PHPDoc comment for the HTML Tag Processor class previously showed calling next_tag() with an array containing a class key, which should have been class_name. This patch fixes this by using the appropriate class_name key.

Props: @gaambo, @crstauf, @atachibana

As a documentation change this should have no impact on any code and should need no testing.

[audrasjb]

Thanks for the report and PR. Self assigning for commit consideration.

[Bernhard Reiter]

Since this has been sitting for a while and I'm committing a few things right now anyway, I'm taking this over. Hope that's okay @audrasjb -- otherwise kindly let me know if I'm overstepping :)

[Bernhard Reiter]

In 57116:

HTML API: Fix typo in documentation example.

The example code in the PHPDoc comment for the HTML Tag Processor class
previously showed calling next_tag() with an array containing a class
key, which should have been class_name. This patch fixes this by using
the appropriate class_name key.

Props dmsnell, gaambo, crstauf, atachibana, audrasjb, krupalpanchal.
Fixes #59891.

Committed to Core in https://core.trac.wordpress.org/changeset/57116.

[Bernhard Reiter]

Reopening for backporting to the 6.4 branch.

This is a (minor) doc fix that seems to make sense to have in 6.4.x, as it might otherwise continue to throw people off while they're using the HTML API (potentially causing them to re-report the issue).

[Bernhard Reiter]

In 57117:

HTML API: Fix typo in documentation example.

The example code in the PHPDoc comment for the HTML Tag Processor class
previously showed calling next_tag() with an array containing a class
key, which should have been class_name. This patch fixes this by using
the appropriate class_name key.

Merges [57116] to the 6.4 branch.

Props dmsnell, gaambo, crstauf, atachibana, audrasjb, krupalpanchal.
Fixes #59891.

Backported to Core's 6.4 branch in https://core.trac.wordpress.org/changeset/57117.