Ticket #36244: 36244-with-filter.patch

src/wp-includes/general-template.php

@@ -1768 +1768 @@
          */
         return apply_filters( 'get_archives_link', $link_html, $url, $text, $format, $before, $after, $selected );
 }
-
 /**
  * Display archive links based on type and format.
  *
@@ -1784 +1783 @@
  * @param string|array $args {
  *     Default archive links arguments. Optional.
  *
- *     @type string     $type            Type of archive to retrieve. Accepts 'daily', 'weekly', 'monthly',
- *                                       'yearly', 'postbypost', or 'alpha'. Both 'postbypost' and 'alpha'
- *                                       display the same archive link list as well as post titles instead
- *                                       of displaying dates. The difference between the two is that 'alpha'
- *                                       will order by post title and 'postbypost' will order by post date.
- *                                       Default 'monthly'.
- *     @type string|int $limit           Number of links to limit the query to. Default empty (no limit).
- *     @type string     $format          Format each link should take using the $before and $after args.
- *                                       Accepts 'link' (`<link>` tag), 'option' (`<option>` tag), 'html'
- *                                       (`<li>` tag), or a custom format, which generates a link anchor
- *                                       with $before preceding and $after succeeding. Default 'html'.
- *     @type string     $before          Markup to prepend to the beginning of each link. Default empty.
- *     @type string     $after           Markup to append to the end of each link. Default empty.
- *     @type bool       $show_post_count Whether to display the post count alongside the link. Default false.
- *     @type bool|int   $echo            Whether to echo or return the links list. Default 1|true to echo.
- *     @type string     $order           Whether to use ascending or descending order. Accepts 'ASC', or 'DESC'.
- *                                       Default 'DESC'.
- *     @type string     $post_type       Post type. Default 'post'.
- *     @type string     $year            Year. Default current year.
- *     @type string     $monthnum        Month number. Default current month number.
- *     @type string     $day             Day. Default current day.
- *     @type string     $w               Week. Default current week.
+ *     @type string     $type                    Type of archive to retrieve. Accepts 'daily', 'weekly', 'monthly',
+ *                                               'yearly', 'postbypost', or 'alpha'. Both 'postbypost' and 'alpha'
+ *                                               display the same archive link list as well as post titles instead
+ *                                               of displaying dates. The difference between the two is that 'alpha'
+ *                                               will order by post title and 'postbypost' will order by post date.
+ *                                               Default 'monthly'.
+ *     @type string|int $limit                   Number of links to limit the query to. Default empty (no limit).
+ *     @type string     $format                  Format each link should take using the $before and $after args.
+ *                                               Accepts 'link' (`<link>` tag), 'option' (`<option>` tag), 'html'
+ *                                               (`<li>` tag), or a custom format, which generates a link anchor
+ *                                               with $before preceding and $after succeeding. Default 'html'.
+ *     @type string     $before                  Markup to prepend to the beginning of each link. Default empty.
+ *     @type string     $after                   Markup to append to the end of each link. Default empty.
+ *     @type bool       $show_post_count         Whether to display the post count alongside the link. Default false.
+ *     @type bool|int   $echo                    Whether to echo or return the links list. Default 1|true to echo.
+ *     @type string     $order                   Whether to use ascending or descending order. Accepts 'ASC', or 'DESC'.
+ *                                               Default 'DESC'.
+ *     @type string     $post_type               Post type. Default 'post'.
+ *     @type string     $year                    Year. Default current year.
+ *     @type string     $monthnum                Month number. Default current month number.
+ *     @type string     $day                     Day. Default current day.
+ *     @type string     $w                       Week. Default current week.
+ *     @type string     $archive_week_separator  The symbol used separate dates on weekly archive links Default '&#8211;';
  * }
  * @return void|string Void if 'echo' argument is true, archive links if 'echo' is false.
  */
@@ -1813 +1813 @@
         global $wpdb, $wp_locale;
 
         $defaults = array(
-                'type'            => 'monthly',
-                'limit'           => '',
-                'format'          => 'html',
-                'before'          => '',
-                'after'           => '',
-                'show_post_count' => false,
-                'echo'            => 1,
-                'order'           => 'DESC',
-                'post_type'       => 'post',
-                'year'            => get_query_var( 'year' ),
-                'monthnum'        => get_query_var( 'monthnum' ),
-                'day'             => get_query_var( 'day' ),
-                'w'               => get_query_var( 'w' ),
+                'type'                   => 'monthly',
+                'limit'                  => '',
+                'format'                 => 'html',
+                'before'                 => '',
+                'after'                  => '',
+                'show_post_count'        => false,
+                'echo'                   => 1,
+                'order'                  => 'DESC',
+                'post_type'              => 'post',
+                'year'                   => get_query_var( 'year' ),
+                'monthnum'               => get_query_var( 'monthnum' ),
+                'day'                    => get_query_var( 'day' ),
+                'w'                      => get_query_var( 'w' ),
+                /**
+                * Filter what will separate dates on weekly archive links.
+                *
+                * @since 5.4
+                *
+                * @param string '-' (&#8211;) used to split the start and end dates of a week.
+                */
+                'archive_week_separator' => apply_filters( 'wp_get_archives_week_separator', '&#8211;' ),
         );
 
         $parsed_args = wp_parse_args( $args, $defaults );
@@ -1850 +1858 @@
                 $order = 'DESC';
         }
 
-        // this is what will separate dates on weekly archive links
-        $archive_week_separator = '&#8211;';
-
         $sql_where = $wpdb->prepare( "WHERE post_type = %s AND post_status = 'publish'", $parsed_args['post_type'] );
 
         /**
@@ -1985 +1990 @@
                                         if ( 'post' !== $parsed_args['post_type'] ) {
                                                 $url = add_query_arg( 'post_type', $parsed_args['post_type'], $url );
                                         }
-                                        $text = $arc_week_start . $archive_week_separator . $arc_week_end;
+                                        $text = $arc_week_start . $parsed_args['archive_week_separator'] . $arc_week_end;
                                         if ( $parsed_args['show_post_count'] ) {
                                                 $parsed_args['after'] = '&nbsp;(' . $result->posts . ')' . $after;
                                         }
@@ -2028 +2033 @@
         }
 }
 
+
 /**
  * Get number of days since the start of the week.
  *