Make WordPress Core


Ignore:
Timestamp:
03/07/2023 04:46:48 PM (15 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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/html-api/class-wp-html-tag-processor.php

    r55469 r55477  
    4141 * ```php
    4242 *     $tags = new WP_HTML_Tag_Processor( $html );
    43  *     if ( $tags->next_tag( array( 'tag_name' => 'option' ) ) ) {
     43 *     if ( $tags->next_tag( 'option' ) ) {
    4444 *         $tags->set_attribute( 'selected', true );
    4545 *     }
     
    5959 * ```
    6060 *
    61  * | Goal                                                      | Query                                                                      |
    62  * |-----------------------------------------------------------|----------------------------------------------------------------------------|
    63  * | Find any tag.                                             | `$tags->next_tag();`                                                       |
     61 * | Goal                                                      | Query                                                                           |
     62 * |-----------------------------------------------------------|---------------------------------------------------------------------------------|
     63 * | Find any tag.                                             | `$tags->next_tag();`                                                            |
    6464 * | Find next image tag.                                      | `$tags->next_tag( array( 'tag_name' => 'img' ) );`                              |
     65 * | Find next image tag (without passing the array).          | `$tags->next_tag( 'img' );`                                                     |
    6566 * | Find next tag containing the `fullwidth` CSS class.       | `$tags->next_tag( array( 'class_name' => 'fullwidth' ) );`                      |
    6667 * | Find next image tag containing the `fullwidth` CSS class. | `$tags->next_tag( array( 'tag_name' => 'img', 'class_name' => 'fullwidth' ) );` |
     
    16111612     *     $p->get_attribute( 'aria-label' ) === null;
    16121613     *
    1613      *     $p->next_tag( array() ) === false;
     1614     *     $p->next_tag() === false;
    16141615     *     $p->get_attribute( 'class' ) === null;
    16151616     * ```
     
    16921693     *     $p->get_attribute_names_with_prefix( 'data-' ) === array( 'data-enabled', 'data-test-id' );
    16931694     *
    1694      *     $p->next_tag( array() ) === false;
     1695     *     $p->next_tag() === false;
    16951696     *     $p->get_attribute_names_with_prefix( 'data-' ) === null;
    16961697     * ```
     
    17231724     * ```php
    17241725     *     $p = new WP_HTML_Tag_Processor( '<DIV CLASS="test">Test</DIV>' );
    1725      *     $p->next_tag( array() ) === true;
     1726     *     $p->next_tag() === true;
    17261727     *     $p->get_tag() === 'DIV';
    17271728     *
    1728      *     $p->next_tag( array() ) === false;
     1729     *     $p->next_tag() === false;
    17291730     *     $p->get_tag() === null;
    17301731     * ```
Note: See TracChangeset for help on using the changeset viewer.