From ec3b4135da6e892cea1b00897147d56d7c8ba97d Mon Sep 17 00:00:00 2001 From: Tonya Mork Date: Thu, 9 Sep 2021 19:41:53 +0000 Subject: [PATCH] Code Modernization: Fix parameter name mismatches for parent/child classes in `WP_Sitemaps_Provider::get_max_num_pages()`. In each child class, renames the 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. Note: Reassignment is done after the guard clause. Why? To avoid unnecessary processing and memory should the method bail out. Follow-up to [48072]. Props jrf, hellofromTonya, sergeybiryukov, azaozz, desrosj, johnbillion. See #51553. git-svn-id: https://develop.svn.wordpress.org/trunk@51788 602fd350-edb4-49c9-b593-d223f7449a82 --- .../sitemaps/providers/class-wp-sitemaps-posts.php | 11 ++++++++--- .../providers/class-wp-sitemaps-taxonomies.php | 11 ++++++++--- 2 files changed, 16 insertions(+), 6 deletions(-) diff --git a/src/wp-includes/sitemaps/providers/class-wp-sitemaps-posts.php b/src/wp-includes/sitemaps/providers/class-wp-sitemaps-posts.php index c9d982ddce..701d170a6a 100644 --- a/src/wp-includes/sitemaps/providers/class-wp-sitemaps-posts.php +++ b/src/wp-includes/sitemaps/providers/class-wp-sitemaps-posts.php @@ -148,15 +148,20 @@ class WP_Sitemaps_Posts extends WP_Sitemaps_Provider { * Gets the max number of pages available for the object type. * * @since 5.5.0 + * @since 5.9.0 Renamed `$post_type` to `$object_subtype` to match parent class + * for PHP 8 named parameter support. * - * @param string $post_type Optional. Post type name. Default empty. + * @param string $object_subtype Optional. Post type name. Default empty. * @return int Total number of pages. */ - public function get_max_num_pages( $post_type = '' ) { - if ( empty( $post_type ) ) { + public function get_max_num_pages( $object_subtype = '' ) { + if ( empty( $object_subtype ) ) { return 0; } + // Restores the more descriptive, specific name for use within this method. + $post_type = $object_subtype; + /** * Filters the max number of pages before it is generated. * diff --git a/src/wp-includes/sitemaps/providers/class-wp-sitemaps-taxonomies.php b/src/wp-includes/sitemaps/providers/class-wp-sitemaps-taxonomies.php index f5b6bb631a..636815397e 100644 --- a/src/wp-includes/sitemaps/providers/class-wp-sitemaps-taxonomies.php +++ b/src/wp-includes/sitemaps/providers/class-wp-sitemaps-taxonomies.php @@ -134,15 +134,20 @@ class WP_Sitemaps_Taxonomies extends WP_Sitemaps_Provider { * Gets the max number of pages available for the object type. * * @since 5.5.0 + * @since 5.9.0 Renamed `$taxonomy` to `$object_subtype` to match parent class + * for PHP 8 named parameter support. * - * @param string $taxonomy Taxonomy name. + * @param string $object_subtype Optional. Taxonomy name. Default empty. * @return int Total number of pages. */ - public function get_max_num_pages( $taxonomy = '' ) { - if ( empty( $taxonomy ) ) { + public function get_max_num_pages( $object_subtype = '' ) { + if ( empty( $object_subtype ) ) { return 0; } + // Restores the more descriptive, specific name for use within this method. + $taxonomy = $object_subtype; + /** * Filters the max number of pages before it is generated. *