Skip to content

General: Correct wp_list_pages() include param docblock and add coverage #13431

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
irozum wants to merge 2 commits into
base: trunk
Choose a base branch
from
+17 −1
Open

General: Correct wp_list_pages() include param docblock and add coverage #13431

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
56dc528
Docs: Correct wp_list_pages() include param type and description
irozum Sep 7, 2026
6ad47e0
Tests: Cover wp_list_pages() include accepting an array of page IDs
irozum Sep 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/wp-includes/post-template.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1288,7 +1288,7 @@ function wp_dropdown_pages( $args = '' ) {
* the given n depth). Default 0.
* @type bool $echo Whether or not to echo the list of pages. Default true.
* @type string $exclude Comma-separated list of page IDs to exclude. Default empty.
* @type array $include Comma-separated list of page IDs to include. Default empty.
* @type int[]|string $include Array or comma-separated list of page IDs to include. Default empty array.
Comment on lines 1290 to +1291

@westonruter westonruter Sep 8, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As noted in my ticket comment, I think both $include and $exclude should be changed to be documented to be int[], and for the function to leverage wp_parse_id_list().

* @type string $link_after Text or HTML to follow the page link label. Default null.
* @type string $link_before Text or HTML to precede the page link label. Default null.
* @type string $post_type Post type to query for. Default 'page'.
Expand Down
16 changes: 16 additions & 0 deletions tests/phpunit/tests/post/wpListPages.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -437,6 +437,22 @@ public function test_wp_list_pages_include() {
$this->assertSameIgnoreEOL( $expected, wp_list_pages( $args ) );
}

/**
* @ticket 66052
*/
public function test_wp_list_pages_include_accepts_array_of_ids() {
$args = array(
'echo' => false,
'include' => array( self::$parent_1, self::$parent_3 ),
);

$expected = '<li class="pagenav">Pages<ul><li class="page_item page-item-' . self::$parent_1 . '"><a href="' . get_permalink( self::$parent_1 ) . '">Parent 1</a></li>
<li class="page_item page-item-' . self::$parent_3 . '"><a href="' . get_permalink( self::$parent_3 ) . '">Parent 3</a></li>
</ul></li>';

$this->assertSameIgnoreEOL( $expected, wp_list_pages( $args ) );
}

public function test_wp_list_pages_exclude_tree() {
$args = array(
'echo' => false,
Expand Down
Loading