Add dynamic return type for get_permalink()/get_the_permalink()

[IanDelMar]

Adds dynamic function return type extension for get_permalink() and get_the_permalink().

[herndlm]

Also small idea for an improvement - what do you think of letting it return false in case the arg is not an object AND not an integer? That could help find some false usages of those functions :)

[szepeviktor]

@IanDelMar Thank you for working on a Saturday! 📅

[IanDelMar]

Also small idea for an improvement - what do you think of letting it return false in case the arg is not an object AND not an integer? That could help find some false usages of those functions :)

PHPStan knows that the first argument must be of type int or WP_Post because of the stubs file. So there is an error if you use a non integer, non WP_Post argument. Using a string type argument gives Parameter #1 $post of function get_permalink expects int|WP_Post, string given.

Using the return value as an argument for a function that expects a string, e.g. str_replace( 'a string', 'a new string', get_permalink( 'not expected string' ) ) gives Parameter #3 $subject of function str_replace expects array|string, string|false given.

But maybe it is helpful for some users to have Parameter #3 $subject of function str_replace expects array|string, false given. instead.

[herndlm]

Oh, of course, makes sense. Thx!