function paginate_comments_links() results in a Notice instead of returning an array when 'type' is set to 'array'

[anantajitjg]

function paginate_comments_links() produced a Notice ( Array to string conversion in /opt/lampp/htdocs/wordpress/wp-includes/link-template.php on line 2796 ) instead of returning an array when 'type' is set to 'array'. This function does return an array if 'echo' is set to false, which is pretty confusing ( user needs to pass an additional option of 'echo' => false when it is clear that user needs an array ) when used with 'type' => 'array'!!

Expected
paginate_comments_links() when 'type' is set to 'array' must return an array.

Actual
Instead of returning an array, a Notice is produced.

Steps to reproduce
call the function as described below,

<?php
$links = paginate_comments_links( array(
 'type' => 'array'
) );

Note: WP_DEBUG is set to true

[SergeyBiryukov]

In 42703:

Comments: Avoid a PHP notice in paginate_comments_links() if type argument is set to array.

The function is a wrapper for paginate_links(), which returns an array if requested.

Props anantajitjg.
Fixes #43299.

[anantajitjg]

Replying to SergeyBiryukov:

In 42703:

Comments: Avoid a PHP notice in paginate_comments_links() if type argument is set to array.

The function is a wrapper for paginate_links(), which returns an array if requested.

Props anantajitjg.
Fixes #43299.

Hi,
This is a follow-up to above bug. If I use paginate_comments_links() with no options passed it will result in, Notice: Undefined index: type in /opt/lampp/htdocs/wordpress/wp-includes/link-template.php on line 2928 when WP_DEBUG is set to true. That's why I set, 'type' => 'plain' in defaults array. May be a better solution can remove this Notice :)

[anantajitjg]

If I use paginate_comments_links() with no options passed it will result in, Notice: Undefined index: type in /opt/lampp/htdocs/wordpress/wp-includes/link-template.php on line 2928 when WP_DEBUG is set to true.

With reference to #comment:4 I am proposing an alternative solution!

[anantajitjg]

alternative solution

[SergeyBiryukov]

In 42736:

Comments: After [42703], make sure $args['type'] in paginate_comments_links() is always defined.

Props anantajitjg.
Fixes #43299.

[SergeyBiryukov]

Fixed in [42703] and [42736].