feat: improve PHPStan

Author: nlemoine

phpstan.neon.dist

@@ -1,10 +1,10 @@
 parameters:
-    level: 5
+    level: 7
     paths:
         - src/
     editorUrl: 'vscode://file/%%file%%:%%line%%'
     scanDirectories:
         - wp-content/plugins/wordpress-seo
     scanFiles:
         - vendor/php-stubs/acf-pro-stubs/acf-pro-stubs.php
-        - vendor/wpsyntex/polylang-stubs/polylang-stubs.php
+        - vendor/wpsyntex/polylang-stubs/polylang-stubs.php

src/integrations/polylang.php

@@ -23,7 +23,7 @@ function get_translated_page_id_cache_key(string $language_slug): string
  * @see https://github.com/polylang/polylang/blob/88ee8ed65af4f92c0225e4faa46d5f3e640173ba/frontend/frontend-static-pages.php#L122-L146
  *
  * @param string $url               not used
- * @param object $language          language in which we want the translation
+ * @param PLL_Language $language          language in which we want the translation
  * @param int    $queried_object_id id of the queried object
  */
 function set_is_posts_page($url, $language, $queried_object_id): string
@@ -35,6 +35,13 @@ function set_is_posts_page($url, $language, $queried_object_id): string
     $GLOBALS['wp_query']->is_posts_page = true;
     return $url;
 }
+/**
+ * Undocumented function
+ *
+ * @param string       $url
+ * @param PLL_Language $language
+ * @param int          $queried_object_id
+ */
 function reset_is_posts_page($url, $language, $queried_object_id): string
 {
     if (!\is_home()) {
@@ -49,6 +56,10 @@ function reset_is_posts_page($url, $language, $queried_object_id): string
 
 /**
  * Set translasted IDs
+ *
+ * @param int[] $page_ids
+ *
+ * @return int[]
  */
 function set_translated_page_id(array $page_ids): array
 {
@@ -149,7 +160,11 @@ function get_default_language_page_id(int $page_id): int
     if (!empty(\pll_current_language())) {
         return $page_id;
     }
-    $default_page_id = \pll_get_post($page_id, \pll_default_language());
+    $default_language = \pll_default_language();
+    if (!$default_language) {
+        return $page_id;
+    }
+    $default_page_id = \pll_get_post($page_id, $default_language);
     return $default_page_id ? $default_page_id : $page_id;
 }
 \add_filter('pfcpt/post_type_from_id/page_id', __NAMESPACE__ . '\\get_default_language_page_id');
@@ -159,7 +174,7 @@ function get_default_language_page_id(int $page_id): int
  *
  * @param int $post_id
  * @param WP_Post $post
- * @param array $translations
+ * @param int[] $translations
  */
 function on_page_for_custom_post_type_change($post_id, $post, $translations): void
 {
@@ -176,6 +191,9 @@ function on_page_for_custom_post_type_change($post_id, $post, $translations): vo
     }
 
     $post_type = \array_search($default_page_for_post_type_id, $page_ids, true);
+    if (!\is_string($post_type)) {
+        return;
+    }
 
     // Flush cache/rules
     $pfcpt->flush_rewrite_rules($post_type);

src/integrations/wordpress-seo.php

@@ -10,7 +10,14 @@
 use Yoast\WP\SEO\Surfaces\Values\Meta;
 
 // Fix Schema
-\add_filter('wpseo_schema_webpage_type', __NAMESPACE__ . '\\fix_schema_webpage_type', 10, 2);
+\add_filter('wpseo_schema_webpage_type', __NAMESPACE__ . '\\fix_schema_webpage_type');
+/**
+ * Add CollectionPage schema to custom post type pages
+ *
+ * @param string|string[] $type
+ *
+ * @return string|string[]
+ */
 function fix_schema_webpage_type($type)
 {
     $pfcpt = Plugin::get_instance();
@@ -37,10 +44,12 @@ function fix_schema_webpage_type($type)
 /**
  * Fix Yoast breadcrumbs on post
  *
+ * @param Indexable[] $indexables
  * @param Meta_Tags_Context $context
- * @return array
+ *
+ * @return Indexable[]
  */
-function fix_post_breadcrumbs(array $indexables, $context)
+function fix_post_breadcrumbs(array $indexables, $context): array
 {
     $current_post_type = $context->indexable->object_sub_type ?? null;
     if (!$current_post_type || !\is_singular($current_post_type)) {
@@ -78,9 +87,11 @@ function fix_post_breadcrumbs(array $indexables, $context)
 /**
  * Fix Yoast breadcrumbs on taxonomy
  *
- * @return array
+ * @param Indexable[] $indexables
+ *
+ * @return Indexable[]
  */
-function fix_taxonomy_breadcrumbs(array $indexables, Meta_Tags_Context $context)
+function fix_taxonomy_breadcrumbs(array $indexables, Meta_Tags_Context $context): array
 {
     $current_taxonomy = $context->indexable->object_sub_type ?? null;
     if (!\is_tax($current_taxonomy)) {
@@ -134,10 +145,12 @@ function fix_taxonomy_breadcrumbs(array $indexables, Meta_Tags_Context $context)
 /**
  * Fix Yoast breadcrumbs on home
  *
+ * @param Indexable[] $indexables
  * @param Meta_Tags_Context $context
- * @return array
+ *
+ * @return Indexable[]
  */
-function fix_home_breadcrumbs(array $indexables, $context)
+function fix_home_breadcrumbs(array $indexables, $context): array
 {
     $pfcpt = Plugin::get_instance();
     if (!$pfcpt->is_query_page_for_custom_post_type()) {
@@ -160,12 +173,12 @@ function fix_home_breadcrumbs(array $indexables, $context)
         $front_page_id = $yoast->helpers->current_page->get_front_page_id();
         if ($front_page_id === 0) {
             $home_page_ancestor = $indexable_repository->find_for_home_page();
-            if (\is_a($home_page_ancestor, Indexable::class)) {
+            if (!\is_bool($home_page_ancestor) && \is_a($home_page_ancestor, Indexable::class)) {
                 $static_ancestors[] = $home_page_ancestor;
             }
         } else {
             $static_ancestor = $indexable_repository->find_by_id_and_type($front_page_id, 'post');
-            if (\is_a($static_ancestor, Indexable::class) && $static_ancestor->post_status !== 'unindexed') {
+            if (!\is_bool($static_ancestor) && \is_a($static_ancestor, Indexable::class) && $static_ancestor->post_status !== 'unindexed') {
                 $static_ancestors[] = $static_ancestor;
             }
         }
@@ -178,16 +191,6 @@ function fix_home_breadcrumbs(array $indexables, $context)
     return $indexables;
 }
 
-function add_filter_once($hook, $callback, $priority = 10, $args = 1)
-{
-    $singular = function () use ($hook, $callback, $priority, $args, &$singular) {
-        \call_user_func_array($callback, \func_get_args());
-        \remove_filter($hook, $singular, $priority);
-    };
-
-    return \add_filter($hook, $singular, $priority, $args);
-}
-
 /**
  * Shortcircuit get_option to return the page ID for a custom post type
  *

src/plugin.php

@@ -198,7 +198,11 @@ public function update_post_type_args(array $args, string $post_type): array
     public function get_page_slug(int $page_id): ?string
     {
         $page_url = \get_permalink($page_id);
-        return $page_url ? \trim(\parse_url($page_url, PHP_URL_PATH), '/') : null;
+        if ($page_url === false) {
+            return null;
+        }
+        $page_path = \parse_url($page_url, PHP_URL_PATH);
+        return \is_string($page_path) ? \trim($page_path, '/') : null;
     }
 
     /**
@@ -365,8 +369,10 @@ public function page_for_post_type_field(array $args): void
     /**
      * Add an indicator to show if a page is set as a post type archive.
      *
-     * @param array   $post_states an array of post states to display after the post title
+     * @param string[]   $post_states an array of post states to display after the post title
      * @param WP_Post $post        the current post object
+     *
+     * @return string[]
      */
     public function display_post_states($post_states, $post): array
     {
@@ -524,7 +530,9 @@ public function is_query_page_for_custom_post_type(?WP_Query $query = null): boo
     /**
      * Change the template hierarchy on pages for custom post type
      *
-     * @param array<string> $templates
+     * @param string[] $templates
+     *
+     * @return string[]
      */
     public function set_home_template_hierarchy(array $templates): array
     {
@@ -626,6 +634,8 @@ public function get_page_id_from_query(WP_Query $query): ?int
 
     /**
      * Get page ids.
+     *
+     * @return int[]
      */
     public function get_page_ids(bool $apply_filters = true): array
     {
@@ -808,6 +818,8 @@ private function delete_option(string $post_type): void
 
     /**
      * Get post types.
+     *
+     * @return WP_Post_Type[]
      */
     private function get_post_types(): array
     {

tests/integration/test-page-for-custom-post-type.php

@@ -11,7 +11,9 @@ class TestPageForCustomPostType extends Testkit_Test_Case
 {
     private string $home_for_book_title = 'Home for Books';
 
-    private int $home_page_id;
+    private int $static_front_page_id;
+
+    private int $static_page_for_posts_id;
 
     private int $home_for_book_id;
 
@@ -70,9 +72,21 @@ public function test_query()
         ], $hierarchy->hierarchy());
     }
 
+    public function test_query_with_static_pages_set()
+    {
+        // update_option('show_on_front', 'page');
+        // update_option('page_on_front', $this->static_front_page_id);
+        // update_option('page_for_posts', $this->static_page_for_posts_id);
+
+        $this->get(\get_permalink($this->home_for_book_id));
+
+        global $wp_query;
+        $this->assertEquals(\get_post_type_archive_link('post'), \get_permalink($this->static_page_for_posts_id));
+    }
+
     public function test_query_on_non_home_page()
     {
-        $this->get(\get_permalink($this->home_page_id));
+        $this->get(\get_permalink($this->static_front_page_id));
 
         global $wp_query;
         $this->assertTrue(\property_exists($wp_query, 'is_page_for_custom_post_type'));
@@ -262,15 +276,26 @@ private function setup_data()
             $this->bike_post_type => $this->home_for_bike_id,
         ]);
 
-        $home = \get_page_by_path('welcome-home');
-        if (!$home) {
-            $this->home_page_id = self::factory()->post->create([
+        $front_page = \get_page_by_path('welcome-home');
+        if (!$front_page) {
+            $this->static_front_page_id = self::factory()->post->create([
                 'post_type'  => 'page',
                 'post_title' => 'Welcome Home!',
                 'post_name'  => 'welcome-home',
             ]);
         } else {
-            $this->home_page_id = $home->ID;
+            $this->static_front_page_id = $front_page->ID;
+        }
+
+        $page_for_posts = \get_page_by_path('posts-page');
+        if (!$page_for_posts) {
+            $this->static_page_for_posts_id = self::factory()->post->create([
+                'post_type'  => 'page',
+                'post_title' => 'Posts Page',
+                'post_name'  => 'posts-page',
+            ]);
+        } else {
+            $this->static_page_for_posts_id = $page_for_posts->ID;
         }
     }
 }