Changeset 59908

Timestamp:

03/03/2025 07:54:34 PM (2 months ago)

Author:

audrasjb

Message:

Widgets: Add post type support to get_calendar() function.

This changeset updates the get_calendar() function to allow post type filtering via the $post_type parameter, with backard compatibility for previous params. It also updates the related get_calendar_args and get_calendar hooks accordingly.

Props sebastianpisula, swissspidy, dwainm, moxie, sukhendu2002, audrasjb, mukesh27.
Fixes #34093.

Location:

trunk

Files:

• src/wp-includes/general-template.php (modified) (8 diffs)
• tests/phpunit/tests/functions/getCalendar.php (added)

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

@@ -2234 +2234 @@
  *
  * @since 1.0.0
+ * @since 6.8.0 New argument $args added, with backward compatibility.
  *
  * @global wpdb      $wpdb      WordPress database abstraction object.
@@ -2242 +2243 @@
  * @global array     $posts
  *
- * @param bool $initial Optional. Whether to use initial calendar names. Default true.
- * @param bool $display Optional. Whether to display the calendar output. Default true.
+ * @param array $args {
+ *     Optional. Arguments for the `get_calendar` function.
+ *
+ *     @type bool $initial   Whether to use initial calendar names. Default true.
+ *     @type bool $display   Whether to display the calendar output. Default true.
+ *     @type string $post_type Optional. Post type. Default 'post'.
+ * }
  * @return void|string Void if `$display` argument is true, calendar HTML if `$display` is false.
  */
-function get_calendar( $initial = true, $display = true ) {
+function get_calendar( $args = array() ) {
     global $wpdb, $m, $monthnum, $year, $wp_locale, $posts;
+
+    $defaults = array(
+        'initial'   => true,
+        'display'   => true,
+        'post_type' => 'post',
+    );
+
+    $original_args = func_get_args();
+    $args          = array();
+
+    if ( ! empty( $original_args ) ) {
+        if ( ! is_array( $original_args[0] ) ) {
+            if ( isset( $original_args[0] ) && is_bool( $original_args[0] ) ) {
+                $defaults['initial'] = $original_args[0];
+            }
+            if ( isset( $original_args[1] ) && is_bool( $original_args[1] ) ) {
+                $defaults['display'] = $original_args[1];
+            }
+        } else {
+            $args = $original_args[0];
+        }
+    }
+
+    /**
+     * Filter the `get_calendar` function arguments before they are used.
+     *
+     * @since 6.8.0
+     *
+     * @param array $args {
+     *     Optional. Arguments for the `get_calendar` function.
+     *
+     *     @type bool $initial   Whether to use initial calendar names. Default true.
+     *     @type bool $display   Whether to display the calendar output. Default true.
+     *     @type string $post_type Optional. Post type. Default 'post'.
+     * }
+     * @return array The arguments for the `get_calendar` function.
+     */
+    $args = apply_filters( 'get_calendar_args', wp_parse_args( $args, $defaults ) );
 
     $key   = md5( $m . $monthnum . $year );
@@ -2254 +2298 @@
     if ( $cache && is_array( $cache ) && isset( $cache[ $key ] ) ) {
         /** This filter is documented in wp-includes/general-template.php */
-        $output = apply_filters( 'get_calendar', $cache[ $key ] );
-
-        if ( $display ) {
+        $output = apply_filters( 'get_calendar', $cache[ $key ], $args );
+
+        if ( $args['display'] ) {
             echo $output;
             return;
@@ -2268 +2312 @@
     }
 
+    $post_type = $args['post_type'];
+    if ( ! post_type_exists( $post_type ) ) {
+        $post_type = 'post';
+    }
+
     // Quick check. If we have no posts at all, abort!
     if ( ! $posts ) {
-        $gotsome = $wpdb->get_var( "SELECT 1 as test FROM $wpdb->posts WHERE post_type = 'post' AND post_status = 'publish' LIMIT 1" );
+        $prepared_query = $wpdb->prepare( "SELECT 1 as test FROM $wpdb->posts WHERE post_type = %s AND post_status = 'publish' LIMIT 1", $post_type );
+        $gotsome        = $wpdb->get_var( $prepared_query );
         if ( ! $gotsome ) {
             $cache[ $key ] = '';
@@ -2310 +2360 @@
 
     // Get the next and previous month and year with at least one post.
-    $previous = $wpdb->get_row(
+    $previous_prepared_query = $wpdb->prepare(
         "SELECT MONTH(post_date) AS month, YEAR(post_date) AS year
         FROM $wpdb->posts
         WHERE post_date < '$thisyear-$thismonth-01'
-        AND post_type = 'post' AND post_status = 'publish'
+        AND post_type = %s AND post_status = 'publish'
         ORDER BY post_date DESC
-        LIMIT 1"
+        LIMIT 1",
+        $post_type
     );
-    $next     = $wpdb->get_row(
+    $previous                = $wpdb->get_row( $previous_prepared_query );
+
+    $next_prepared_query = $wpdb->prepare(
         "SELECT MONTH(post_date) AS month, YEAR(post_date) AS year
         FROM $wpdb->posts
         WHERE post_date > '$thisyear-$thismonth-{$last_day} 23:59:59'
-        AND post_type = 'post' AND post_status = 'publish'
+        AND post_type = %s AND post_status = 'publish'
         ORDER BY post_date ASC
-        LIMIT 1"
+        LIMIT 1",
+        $post_type
     );
+    $next                = $wpdb->get_row( $next_prepared_query );
 
     /* translators: Calendar caption: 1: Month name, 2: 4-digit year. */
@@ -2345 +2400 @@
 
     foreach ( $myweek as $wd ) {
-        $day_name         = $initial ? $wp_locale->get_weekday_initial( $wd ) : $wp_locale->get_weekday_abbrev( $wd );
+        $day_name         = $args['initial'] ? $wp_locale->get_weekday_initial( $wd ) : $wp_locale->get_weekday_abbrev( $wd );
         $wd               = esc_attr( $wd );
         $calendar_output .= "\n\t\t<th scope=\"col\" aria-label=\"$wd\">$day_name</th>";
@@ -2359 +2414 @@
 
     // Get days with posts.
-    $dayswithposts = $wpdb->get_results(
+    $dayswithposts_prepared_query = $wpdb->prepare(
         "SELECT DISTINCT DAYOFMONTH(post_date)
         FROM $wpdb->posts WHERE post_date >= '{$thisyear}-{$thismonth}-01 00:00:00'
-        AND post_type = 'post' AND post_status = 'publish'
+        AND post_type = %s AND post_status = 'publish'
         AND post_date <= '{$thisyear}-{$thismonth}-{$last_day} 23:59:59'",
-        ARRAY_N
+        $post_type
     );
+    $dayswithposts                = $wpdb->get_results( $dayswithposts_prepared_query, ARRAY_N );
 
     if ( $dayswithposts ) {
@@ -2453 +2509 @@
     wp_cache_set( 'get_calendar', $cache, 'calendar' );
 
-    if ( $display ) {
-        /**
-         * Filters the HTML calendar output.
-         *
-         * @since 3.0.0
-         *
-         * @param string $calendar_output HTML output of the calendar.
-         */
-        echo apply_filters( 'get_calendar', $calendar_output );
+    /**
+     * Filters the HTML calendar output.
+     *
+     * @since 3.0.0
+     * @since 6.8.0 New argument $args added, with backward compatibility.
+     *
+     * @param string $calendar_output HTML output of the calendar.
+     * @param array  $args {
+     *     Optional. Array of display arguments.
+     *
+     *     @type bool $initial   Whether to use initial calendar names. Default true.
+     *     @type bool $display   Whether to display the calendar output. Default true.
+     *     @type string $post_type Optional. Post type. Default 'post'.
+     * }
+     */
+    $calendar_output = apply_filters( 'get_calendar', $calendar_output, $args );
+
+    if ( $args['display'] ) {
+        echo $calendar_output;
         return;
     }
-    /** This filter is documented in wp-includes/general-template.php */
-    return apply_filters( 'get_calendar', $calendar_output );
+
+    return $calendar_output;
 }