Changeset 51787

Timestamp:

09/09/2021 07:20:56 PM (3 weeks ago)

Author:

hellofromTonya

Message:

Code Modernization: Fix parameter name mismatches for parent/child classes in WP_Sitemaps_Provider::get_url_list().

In each child and grandchild class, renames the second parameter to match the parent's method signature.
Why? PHP 8 introduces the ability to pass named arguments to function/method calls. This means the child and parent method signatures (i.e. parameter names) need to match.

Adds @since to clearly specify why the change happened.

Reassigns the generic parameter to the original parameter.
Why? Restoring the original name keeps the context intact within the method and makes the code more readable. An inline comment explains why this reassignment is made.

Follow-up to [48072].

Props jrf, hellofromTonya, sergeybiryukov, azaozz, desrosj, johnbillion.
See #51553.

Location:

trunk/src/wp-includes/sitemaps/providers

Files:

• class-wp-sitemaps-posts.php (modified) (1 diff)
• class-wp-sitemaps-taxonomies.php (modified) (1 diff)

trunk/src/wp-includes/sitemaps/providers/class-wp-sitemaps-posts.php

@@ -54 +54 @@
      *
      * @since 5.5.0
-     *
-     * @param int    $page_num  Page of results.
-     * @param string $post_type Optional. Post type name. Default empty.
+     * @since 5.9.0 Renamed `$post_type` to `$object_subtype` to match parent class
+     *              for PHP 8 named parameter support.
+     *
+     * @param int    $page_num       Page of results.
+     * @param string $object_subtype Optional. Post type name. Default empty.
+     *
      * @return array Array of URLs for a sitemap.
      */
-    public function get_url_list( $page_num, $post_type = '' ) {
+    public function get_url_list( $page_num, $object_subtype = '' ) {
+        // Restores the more descriptive, specific name for use within this method.
+        $post_type = $object_subtype;
+
         // Bail early if the queried post type is not supported.
         $supported_types = $this->get_object_subtypes();

trunk/src/wp-includes/sitemaps/providers/class-wp-sitemaps-taxonomies.php

@@ -52 +52 @@
      *
      * @since 5.5.0
-     *
-     * @param int    $page_num Page of results.
-     * @param string $taxonomy Optional. Taxonomy name. Default empty.
+     * @since 5.9.0 Renamed `$taxonomy` to `$object_subtype` to match parent class
+     *              for PHP 8 named parameter support.
+     *
+     * @param int    $page_num       Page of results.
+     * @param string $object_subtype Optional. Taxonomy name. Default empty.
      * @return array Array of URLs for a sitemap.
      */
-    public function get_url_list( $page_num, $taxonomy = '' ) {
+    public function get_url_list( $page_num, $object_subtype = '' ) {
+        // Restores the more descriptive, specific name for use within this method.
+        $taxonomy        = $object_subtype;
         $supported_types = $this->get_object_subtypes();