Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add post type support to get_calendar() function #8251

Open
wants to merge 7 commits into
base: trunk
Choose a base branch
from
Open

Add post type support to get_calendar() function #8251

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7893c77
Add post type support to get_calendar() function and related tests
Sukhendu2002 Feb 4, 2025
775e6da
Add related unit tests
Sukhendu2002 Feb 4, 2025
04fecae
Update func_get_args() usage in get_calendar()
Sukhendu2002 Feb 4, 2025
6860b8b
Update spacing
Sukhendu2002 Feb 4, 2025
714b79e
Remove redundant teardown
Sukhendu2002 Feb 5, 2025
faa0c7c
Fix PHPCS Errors
Sukhendu2002 Feb 5, 2025
bfc4bf7
Use get_echo() utility in get_calendar test
Sukhendu2002 Feb 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
121 changes: 93 additions & 28 deletions src/wp-includes/general-template.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2233,6 +2233,7 @@ function calendar_week_mod( $num ) {
* no posts for the month, then it will not be displayed.
*
* @since 1.0.0
* @since 6.8.0 New argument $args added.
*
* @global wpdb $wpdb WordPress database abstraction object.
* @global int $m
Expand All @@ -2241,21 +2242,64 @@ function calendar_week_mod( $num ) {
* @global WP_Locale $wp_locale WordPress date and time locale object.
* @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() ) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about Backward compatibility. Previously it was two args not one?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The function handles backward compatibility through func_get_args().

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];
		}
	}

This allows both old code get_calendar(true, false) and new code get_calendar(['initial' => true]) to work without breaking existing implementations.

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 );
$cache = wp_cache_get( 'get_calendar', 'calendar' );

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 ] );
$output = apply_filters( 'get_calendar', $cache[ $key ], $args );

if ( $display ) {
if ( $args['display'] ) {
echo $output;
return;
}
Expand All @@ -2267,9 +2311,15 @@ function get_calendar( $initial = true, $display = true ) {
$cache = array();
}

$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 ] = '';
wp_cache_set( 'get_calendar', $cache, 'calendar' );
Expand Down Expand Up @@ -2309,22 +2359,27 @@ function get_calendar( $initial = true, $display = true ) {
$last_day = gmdate( 't', $unixmonth );

// 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. */
$calendar_caption = _x( '%1$s %2$s', 'calendar caption' );
Expand All @@ -2344,7 +2399,7 @@ function get_calendar( $initial = true, $display = true ) {
}

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>";
}
Expand All @@ -2358,14 +2413,14 @@ function get_calendar( $initial = true, $display = true ) {
$daywithpost = array();

// 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 ) {
foreach ( (array) $dayswithposts as $daywith ) {
$daywithpost[] = (int) $daywith[0];
Expand Down Expand Up @@ -2452,19 +2507,29 @@ function get_calendar( $initial = true, $display = true ) {
$cache[ $key ] = $calendar_output;
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.
*
* @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;
}

/**
Expand Down
93 changes: 93 additions & 0 deletions tests/phpunit/tests/functions/getCalendar.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
<?php
/**
* Tests for the get_calendar() function.
*
* @since 6.8.0
*
* @group functions
* @group calendar
*
* @covers ::get_calendar
*/
class Tests_Get_Calendar extends WP_UnitTestCase {

/**
* Array of post IDs.
*
* @var int[]
*/
protected static $post_ids = array();

/**
* Set up before class.
*
* @param WP_UnitTest_Factory $factory Test factory.
*/
public static function wpSetUpBeforeClass( WP_UnitTest_Factory $factory ) {
self::$post_ids = $factory->post->create_many(
3,
array(
'post_date' => '2025-02-01 12:00:00',
)
);
}

/**
* Test that get_calendar() displays output when display is true.
*
* @ticket 34093
*/
public function test_get_calendar_display() {
$expected = '<table id="wp-calendar"';
$actual = get_echo( 'get_calendar', array( array( 'display' => true ) ) );
$this->assertStringContainsString( $expected, $actual );
}

/**
* Test that get_calendar() respects the get_calendar_args filter.
*
* @ticket 34093
*/
public function test_get_calendar_args_filter() {
$page_id = self::factory()->post->create(
array(
'post_type' => 'page',
'post_date' => '2025-02-03 12:00:00',
)
);

add_filter(
'get_calendar_args',
function ( $args ) {
$args['post_type'] = 'page';
return $args;
}
);

$calendar_html = get_echo( 'get_calendar' );

remove_all_filters( 'get_calendar_args' );

$this->assertStringContainsString( '<table id="wp-calendar"', $calendar_html );
$this->assertStringContainsString( 'Posts published on February 3, 2025', $calendar_html );
$this->assertStringContainsString( 'February 2025', $calendar_html );
}

/**
* Test that get_calendar() maintains backwards compatibility with old parameter format.
*
* @ticket 34093
*/
public function test_get_calendar_backwards_compatibility() {
$first_calendar_html = get_echo( 'get_calendar', array( false ) );

wp_cache_delete( 'get_calendar', 'calendar' );

$second_calendar_html = get_calendar( false, false );

$this->assertStringContainsString( '<th scope="col" aria-label="Monday">Mon</th>', $first_calendar_html );
$this->assertStringContainsString( 'February 2025', $first_calendar_html );
$this->assertStringContainsString( '<table id="wp-calendar"', $second_calendar_html );
$this->assertStringContainsString( '<th scope="col" aria-label="Monday">Mon</th>', $second_calendar_html );
}
}
Loading