Changeset 61326

Timestamp:

11/30/2025 05:39:27 PM (8 months ago)

Author:

westonruter

Message:

General: Add wp_get_archives_args filter to wp_get_archives().

Developed in ​https://github.com/WordPress/wordpress-develop/pull/10552

Props jeherve, westonruter.
Fixes #64304.

Location:

trunk

Files:

• src/wp-includes/general-template.php (modified) (1 diff)
• tests/phpunit/tests/functions/wpGetArchives.php (modified) (1 diff)

trunk/src/wp-includes/general-template.php

@@ -2019 +2019 @@
         );
 
+        /**
+         * Filters the arguments for displaying archive links.
+         *
+         * @since 7.0.0
+         *
+         * @see wp_get_archives()
+         *
+         * @param array<string, string|int|bool> $args Arguments.
+         */
+        $args = apply_filters( 'wp_get_archives_args', $args );
+
         $parsed_args = wp_parse_args( $args, $defaults );
 

trunk/tests/phpunit/tests/functions/wpGetArchives.php

@@ -205 +205 @@
                 $this->assertSame( $expected, trim( $archives ) );
         }
+
+        /**
+         * @ticket 64304
+         */
+        public function test_wp_get_archives_args_filter() {
+                // Test that the filter can modify the limit argument.
+                add_filter(
+                        'wp_get_archives_args',
+                        static function ( $args ) {
+                                $args['limit'] = 3;
+                                return $args;
+                        }
+                );
+
+                $ids = array_slice( array_reverse( self::$post_ids ), 0, 3 );
+
+                $expected = join(
+                        "\n",
+                        array_map(
+                                static function ( $id ) {
+                                        return sprintf( '<li><a href="%s">%s</a></li>', get_permalink( $id ), get_the_title( $id ) );
+                                },
+                                $ids
+                        )
+                );
+                $archives = wp_get_archives(
+                        array(
+                                'echo'  => false,
+                                'type'  => 'postbypost',
+                                'limit' => 5, // This should be overridden by the filter to 3.
+                        )
+                );
+
+                $this->assertEqualHTML( $expected, $archives );
+        }
 }