New filter: `get_calendar_post_type` in get_calendar()

[sebastian.pisula]

Filter for post type in calendar. If I want show posts from others post type

[swissspidy]

I can see that this enhancement would be helpful.

Just please use $wpdb->prepare to sanitize the post type and check if $post_type is indeed a valid (public) post type.

[dwainm]

requested changes added plus a refreshed patch after revision 36405

[dwainm]

@swissspidy I've updated the patch with your requested changes. Please confirm if this is in order.

[dwainm]

Patch with updated spacing.

[dwainm]

Hi @swissspidy, is the refreshed patch sufficient?

[swissspidy]

Thanks for the ping, and sorry for missing it before!

Implementation-wise it looks OK, just needs a bit of a cleanup eventually (e.g. the spacing is wrong).

I wonder if we should go even one step further and allow passing an $args param to get_calendar(). That way you could configure the post type, whether it should echo, etc. all when calling the function. Of course it should be backwards compatible.

Then, we could have 1 single get_calendar_args filter for these arguments instead of one only for the post type. That means we could use 34093-3.patch​ to build upon.

[dwainm]

Adding array args parameter with backwards compatibly for older argument types. Changing the filter to be applied to all args and not just the post type. Allow post type to be submitted as an argument. Also laying the foundation allowing for other arguments to be added in future.

[dwainm]

Fixed bug where args are being used before filter. Also fix bug where args filter was assigning to $post_type variable and not $args.

[dwainm]

Replying to swissspidy:

Thanks for the ping, and sorry for missing it before!

Implementation-wise it looks OK, just needs a bit of a cleanup eventually (e.g. the spacing is wrong).

I wonder if we should go even one step further and allow passing an $args param to get_calendar(). That way you could configure the post type, whether it should echo, etc. all when calling the function. Of course it should be backwards compatible.

Then, we could have 1 single get_calendar_args filter for these arguments instead of one only for the post type. That means we could use 34093-3.patch​ to build upon.

@swissspidy Please review the changes in 34093-5.diff. The code styling is updated along with the changes your requested.

[swissspidy]

Version is for indicating when a bug was first introduced.

The patch is coming along nicely, thanks @dwainm!

I'm changing milestone to Future Release for now. Also changing the component as get_calendar() is only used in the calendar widget right now. The patch might benefit from some unit tests.

At first glance, the function's docblock needs to be updated. $args should probably be passed to the get_calendar filter.

See ​https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/php/ for our PHP Documentation Standards.

[dwainm]

Adding args to all filters in the function also improve comments.

[dwainm]

Adding basic tests

[moxie]

This would be a very welcome addition to the calendar block/widget. I can imagine I just want to show posts from one category, like lectures or meetings or future/past events. For this kind of simple use it would remove the need for extra (events) plugins.

Trac ticket: https://core.trac.wordpress.org/ticket/34093

[sukhendu2002]

Hi @swissspidy, This improvement looks quite valuable! I've refreshed the patch, would you be able to take a look? Thanks!

[swissspidy]

Oh wow, my last comment here is from 8+ years ago! I don't remember any of that :-)

PR looks like a good start at first glance, but I don't have time for a proper review right now. Maybe @SergeyBiryukov or @audrasjb do.

Otherwise I suggest to bring it up in dev chat or so.

[audrasjb]

Thanks for the ping, @swissspidy!
Self assigning for review/test.

I tested the changeset and it appears it works fine and respect the backward compatibility of this component.

[audrasjb]

In 59908:

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.

[audrasjb]

In 59909:

Docs: Param indentation improvements in get_calendar() function and hooks.

See #34093.

[audrasjb]

Reopening as phpunit tests are failing

https://core.trac.wordpress.org/ticket/34093

[audrasjb]

In 59917:

Widgets: Fix get_calendar() related PHPUnit tests.

This is a temporary fix for PHPUnit tests failures after [59908].

Follow-up to [59908].

See #34093.

[audrasjb]

In 59918:

Widgets: Fix get_calendar() related PHPUnit tests.

This is a new fix for PHPUnit tests failures after [59908].

Follow-up to [59908], [59917].

See #34093.

Trac ticket: https://core.trac.wordpress.org/ticket/34093

[peterwilsoncc]

I got interested and started writing some additional tests while looking at the date issue in the original tests.

It appears there are some caching issues as the post_type and initial parameters are not accounted for when generating the cache key, so there's a few minor fixes to the source code needed.

There's a couple of failing tests in the ​pull request linked to this ticket.

Closing in favor of #8447.

[SergeyBiryukov]

In 59930:

Tests: Move get_calendar() tests to a more appropriate place.

This aims to bring consistency with the tests for the other functions in wp-includes/general-template.php.

Includes correcting the test class name as per the naming conventions.

Follow-up to [59908].

See #34093.

[JeffPaul]

As the primary work on this enhancement has been committed and the remaining work is to resolve the failing PHPUnit tests, I'm going to convert this to a task to allow work to continue on resolving those tests during the 6.8 beta period.

Thanks, I've merged those changes. If you're happy I will commit in the next few hours.

The Chicago in me wants to say you were trying to say "Is youse" which is how "is y'all" would be translated.

It's the same translation down under, maaate. 🦐/BBQ

[peterwilsoncc]

In 59939:

Widgets: Improve caching within get_calendar().

Improves caching of the get_calendar() function by:

• fixing incorrect cache collisions for different initial post_type and week values, and,
• ensuring parameter equivalents generate the same cache key, ie passing the same values in a different order.

Improves tests for the function by:

• navigating to February 2025 in test set up to ensure the correct calendar month is displayed,
• adding messages for tests with multiple assertions,
• improving the tests for the calendar captions by wrapping the expected value in the HTML tag,
• adding dedicated test for the different initial parameter,
• ensuring caches do not collide for different parameters, and,
• ensuring caches do collide for equivalent parameters.

Follow up to r4522, r59908, r59909, r59917 (reverted), r59918 (reverted), r59930.

Props peterwilsoncc, jorbin, audrasjb.
Fixes #34093.