Switch to a different filter name and implementation

see discussion in #10552 (comment)

Author: jeherve

src/wp-includes/general-template.php

@@ -2018,6 +2018,17 @@ function wp_get_archives( $args = '' ) {
 		'w'               => get_query_var( 'w' ),
 	);
 
+	/**
+	 * Filters the archive links list arguments.
+	 *
+	 * @since 7.0.0
+	 *
+	 * @see wp_get_archives()
+	 *
+	 * @param array $args An array of arguments.
+	 */
+	$args = apply_filters( 'wp_get_archives_args', $args );
+
 	$parsed_args = wp_parse_args( $args, $defaults );
 
 	$post_type_object = get_post_type_object( $parsed_args['post_type'] );
@@ -2031,19 +2042,9 @@ function wp_get_archives( $args = '' ) {
 		$parsed_args['type'] = 'monthly';
 	}
 
-	/**
-	 * Filters the limit for the number of posts to include in the archive.
-	 *
-	 * @since 7.0.0
-	 *
-	 * @param int   $limit       The limit for the number of posts to include in the archive. Default 0.
-	 * @param array $parsed_args An array of default arguments.
-	 */
-	$limit_number = (int) apply_filters( 'getarchives_limit', absint( $parsed_args['limit'] ), $parsed_args );
-	if ( $limit_number > 0 ) {
-		$limit = " LIMIT $limit_number";
-	} else {
-		$limit = '';
+	if ( ! empty( $parsed_args['limit'] ) ) {
+		$parsed_args['limit'] = absint( $parsed_args['limit'] );
+		$parsed_args['limit'] = ' LIMIT ' . $parsed_args['limit'];
 	}
 
 	$order = strtoupper( $parsed_args['order'] );
@@ -2080,6 +2081,8 @@ function wp_get_archives( $args = '' ) {
 
 	$last_changed = wp_cache_get_last_changed( 'posts' );
 
+	$limit = $parsed_args['limit'];
+
 	if ( 'monthly' === $parsed_args['type'] ) {
 		$query   = "SELECT YEAR(post_date) AS `year`, MONTH(post_date) AS `month`, count(ID) as posts FROM $wpdb->posts $join $where GROUP BY YEAR(post_date), MONTH(post_date) ORDER BY post_date $order $limit";
 		$key     = md5( $query );

tests/phpunit/tests/functions/wpGetArchives.php

@@ -208,46 +208,37 @@ public function test_wp_get_archives_post_type() {
 	/**
 	 * @ticket 64304
 	 */
-	public function test_wp_get_archives_limit_filter() {
+	public function test_wp_get_archives_args_filter() {
+		// Test that the filter can modify the limit argument.
+		$filter_callback = function( $args ) {
+			$args['limit'] = 3;
+			return $args;
+		};
+		add_filter( 'wp_get_archives_args', $filter_callback );
+
 		$ids = array_slice( array_reverse( self::$post_ids ), 0, 3 );
 
+		$link1 = get_permalink( $ids[0] );
+		$link2 = get_permalink( $ids[1] );
+		$link3 = get_permalink( $ids[2] );
+
 		$title1 = get_post( $ids[0] )->post_title;
 		$title2 = get_post( $ids[1] )->post_title;
 		$title3 = get_post( $ids[2] )->post_title;
 
-		// Test without filter - should return all 3 posts when limit is 3.
-		$archives_without_filter = wp_get_archives(
+		$expected = <<<EOF
+<li><a href='$link1'>$title1</a></li>
+	<li><a href='$link2'>$title2</a></li>
+	<li><a href='$link3'>$title3</a></li>
+EOF;
+		$archives = wp_get_archives(
 			array(
 				'echo'  => false,
 				'type'  => 'postbypost',
-				'limit' => 3,
+				'limit' => 5, // This should be overridden by the filter to 3.
 			)
 		);
-		$this->assertStringContainsString( $title1, $archives_without_filter );
-		$this->assertStringContainsString( $title2, $archives_without_filter );
-		$this->assertStringContainsString( $title3, $archives_without_filter );
-
-		// Add filter to modify limit to 2.
-		add_filter(
-			'getarchives_limit',
-			function ( $limit, $parsed_args ) {
-				// Modify limit from 3 to 2.
-				return 2;
-			},
-			10,
-			2
-		);
 
-		// Test with filter - should return only 2 posts.
-		$archives_with_filter = wp_get_archives(
-			array(
-				'echo'  => false,
-				'type'  => 'postbypost',
-				'limit' => 3,
-			)
-		);
-		$this->assertStringContainsString( $title1, $archives_with_filter );
-		$this->assertStringContainsString( $title2, $archives_with_filter );
-		$this->assertStringNotContainsString( $title3, $archives_with_filter );
+		$this->assertSameIgnoreEOL( $expected, trim( $archives ) );
 	}
 }