`block_template_part` parameter limited to `'header'|'footer'` when `string` should be accepted. about wordpress-stubs

[swissspidy]

Let's just fix this in WordPress itself :-)

https://core.trac.wordpress.org/changeset/58268

[szepeviktor]

Please do not complicate this more.
It can be resolved in local stubs.

[szepeviktor]

diff --git a/functionMap.php b/functionMap.php
index 7065d1f..2619d5e 100644
--- a/functionMap.php
+++ b/functionMap.php
@@ -136,4 +136,5 @@ return [
     'WP_Widget::form' => [null, 'instance' => 'T'],
     'WP_Widget::update' => [null, 'new_instance' => 'T', 'old_instance' => 'T'],
     'WP_Widget::widget' => [null, 'instance' => 'T', 'args' => 'array{name:string,id:string,description:string,class:string,before_widget:string,after_widget:string,before_title:string,after_title:string,before_sidebar:string,after_sidebar:string,show_in_rest:boolean,widget_id:string,widget_name:string}'],
+    'block_template_part' => ['void', 'part' => 'string']
 ];
diff --git a/wordpress-stubs.php b/wordpress-stubs.php
index dfdea96..3a4a5d3 100644
--- a/wordpress-stubs.php
+++ b/wordpress-stubs.php
@@ -95084,6 +95084,7 @@ namespace {
      *
      * @param string $part The block template part to print. Either 'header' or 'footer'.
      * @phpstan-param 'header'|'footer' $part
+     * @phpstan-param string $part
      * @phpstan-return void
      */
     function block_template_part($part)

[szepeviktor]

@johnbillion Do you know where @phpstan-param 'header'|'footer' $part comes from?
Couldn't find it in this repository.

[szepeviktor]

@lipemat Thank you!
What is your specific $part value?

[lipemat]

Varies per project but here are some I was testing with.

1. 'test-part'
2. 'gallery'
3. 'latest-articles'

[szepeviktor]

Do you know where @phpstan-param 'header'|'footer' $part comes from?

wordpress-stubs/src/Visitor.php

Line 635 in a5558fc

$matched = preg_match("#(?>returns|either|one of|accepts|values are|:) ('.+'),? (?>or|and) '([^']+)'#i", $fullDescription, $matches);

[IanDelMar]

Without losing all the 'either ... or ...' constructs, we cannot fix this in the visitor except by skipping predefined functions. So there are basically two options: 1) exclude specific functions, or 2) use the function map to override tags automatically added by identifying expressions that indicate a restricted set of possible values.

[swissspidy]

With 6.6 being released, this issue can be closed once the stubs are updated in this repo.