Ticket #52530: 52530-2.diff

wp-includes/general-template.php

@@ -4266 +4266 @@
         }
 
         $add_args   = $args['add_args'];
-        $r          = '';
+        $result     = '';
         $page_links = array();
         $dots       = false;
 
@@ -4344 +4344 @@
 
         switch ( $args['type'] ) {
                 case 'array':
-                        return $page_links;
+                        $result = $page_links;
+                        break;
 
                 case 'list':
-                        $r .= "<ul class='page-numbers'>\n\t<li>";
-                        $r .= implode( "</li>\n\t<li>", $page_links );
-                        $r .= "</li>\n</ul>\n";
+                        $result .= "<ul class='page-numbers'>\n\t<li>";
+                        $result .= implode( "</li>\n\t<li>", $page_links );
+                        $result .= "</li>\n</ul>\n";
                         break;
 
                 default:
-                        $r = implode( "\n", $page_links );
+                        $result = implode( "\n", $page_links );
                         break;
         }
 
-        return $r;
+        /**
+         * Allow to change paginate_links() result.
+         *
+         * It also applies to all pagination functions, like:
+         * - the_posts_pagination()
+         * - get_the_posts_pagination()
+         * - paginate_comments_links()
+         * - paginate_links().
+         *
+         * @since 5.7.0
+         *
+         * @param string|array $result Pagination HTML or array of elements.
+         * @param string       $type   Type of $sesult. May be: `array`, `list`, `plain`.
+         * @param array        $args   Arguments of {@see paginate_links()}.
+         */
+        return apply_filters( 'get_paginate_links', $result, $args['type'], $args );
 }
 
 /**