Changeset 55477 for trunk/src/wp-includes/html-api/class-wp-html-tag-processor.php

Timestamp:

03/07/2023 04:46:48 PM (19 months ago)

Author:

hellofromTonya

Message:

HTML API: Document shorthand usage of the next_tag().

Documents the shorthand usage, i.e. $this->next_tag( 'img' ), of WP_HTML_Tag_Processor::next_tag().

Also includes table alignments and formatting adjustments in the class docs.

Follow-up to [55203], [55206].

Props zieladam, poena, dmsnell, costdev, hellofromTonya.
Fixes #57863.
See #57575.

File:

• trunk/src/wp-includes/html-api/class-wp-html-tag-processor.php (modified) (5 diffs)

trunk/src/wp-includes/html-api/class-wp-html-tag-processor.php

@@ -41 +41 @@
  * ```php
  *     $tags = new WP_HTML_Tag_Processor( $html );
- *     if ( $tags->next_tag( array( 'tag_name' => 'option' ) ) ) {
+ *     if ( $tags->next_tag( 'option' ) ) {
  *         $tags->set_attribute( 'selected', true );
  *     }
@@ -59 +59 @@
  * ```
  *
- * | Goal                                                      | Query                                                                      |
- * |-----------------------------------------------------------|----------------------------------------------------------------------------|
- * | Find any tag.                                             | `$tags->next_tag();`                                                       |
+ * | Goal                                                      | Query                                                                           |
+ * |-----------------------------------------------------------|---------------------------------------------------------------------------------|
+ * | Find any tag.                                             | `$tags->next_tag();`                                                            |
  * | Find next image tag.                                      | `$tags->next_tag( array( 'tag_name' => 'img' ) );`                              |
+ * | Find next image tag (without passing the array).          | `$tags->next_tag( 'img' );`                                                     |
  * | Find next tag containing the `fullwidth` CSS class.       | `$tags->next_tag( array( 'class_name' => 'fullwidth' ) );`                      |
  * | Find next image tag containing the `fullwidth` CSS class. | `$tags->next_tag( array( 'tag_name' => 'img', 'class_name' => 'fullwidth' ) );` |
@@ -1611 +1612 @@
      *     $p->get_attribute( 'aria-label' ) === null;
      *
-     *     $p->next_tag( array() ) === false;
+     *     $p->next_tag() === false;
      *     $p->get_attribute( 'class' ) === null;
      * ```
@@ -1692 +1693 @@
      *     $p->get_attribute_names_with_prefix( 'data-' ) === array( 'data-enabled', 'data-test-id' );
      *
-     *     $p->next_tag( array() ) === false;
+     *     $p->next_tag() === false;
      *     $p->get_attribute_names_with_prefix( 'data-' ) === null;
      * ```
@@ -1723 +1724 @@
      * ```php
      *     $p = new WP_HTML_Tag_Processor( '<DIV CLASS="test">Test</DIV>' );
-     *     $p->next_tag( array() ) === true;
+     *     $p->next_tag() === true;
      *     $p->get_tag() === 'DIV';
      *
-     *     $p->next_tag( array() ) === false;
+     *     $p->next_tag() === false;
      *     $p->get_tag() === null;
      * ```