Repository navigation
Follow-ups for WP_Locale weekday and month parameter types - #1
Open
westonruter wants to merge 6 commits into
Open
westonruter wants to merge 6 commits into
westonruter wants to merge 6 commits into
Conversation
The `start_of_week` option is cast to an int but otherwise unchecked, so a negative value makes `( $wdcount + $week_begins ) % 7` negative, and a value above 6 is out of range for `WP_Locale::get_weekday()`. Either leads to an undefined array key. Clamping it to 0-6 keeps the weekday headers valid and satisfies the new `int<0, 6>` type of `WP_Locale::get_weekday()`. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…kday_date(). `get_post_time()` returns false when the post date cannot be parsed. Both functions passed that straight to `WP_Locale::get_weekday()`, where it was coerced to the array key 0, so the post was silently labeled Sunday. Now nothing is output in that case, and the filterable string result is cast and clamped to 0-6 to match the `int<0, 6>` type of `WP_Locale::get_weekday()`. This removes the corresponding entry from the `argument.type` PHPStan baseline. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
For each format character whose output has a fixed range, such as `w` for `'0'` through `'6'` or `m` for `'01'` through `'12'`, the conditional return type now gives that range, mirroring what PHPStan infers for `DateTimeInterface::format()`. Formats with an open-ended numeric output give `numeric-string`. Formats that `wp_date()` translates (`D`, `l`, `M`, `F`, `a`, and `A`) and the PHP 8.2+ `X` and `x` remain `string`. With `w` narrowed, the weekday number passed to `WP_Locale::get_weekday()` in the_weekday() and the_weekday_date() already satisfies `int<0, 6>` after an int cast, so the `clamp()` calls are no longer needed. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…int in wp_date(). `DateTimeInterface::format( 'w' )` returns a string from `'0'` to `'6'`, which worked only because the string was coerced to an integer array key. Casting it to an int matches the `int<0, 6>` parameter type and removes the last `get_weekday()` entry from the `argument.type` PHPStan baseline. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…arsed. `wp_date()` only checked the timestamp with `is_numeric()`, which accepts values that `date_create( '@' . $timestamp )` rejects, such as `'1e3'`, `1e20`, `' 5'`, and `'.5'`. For those, `date_create()` returned false and the following `setTimezone()` call caused a fatal error. Now false is returned, as documented for invalid timestamp input and as already done for non-numeric input. This also resolves the PHPStan `method.nonObject` errors on every use of `$datetime` in the function. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Unlike the other `WP_Locale` getters, `get_month()` returns an empty string for a month number that is not found, which was added so that callers like `single_month_title()` can pass unvalidated query var values. Narrowing its parameter to valid month numbers told callers to validate input the method already handles, surfacing errors at call sites that pass `zeroise()` results, query vars, or database values. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. Core Committers: Use this line as a base for the props when committing in SVN: To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. Props Bot commandsYou can trigger Props Bot actions by commenting on this PR:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up changes for WordPress#14827, proposed here because "Allow edits by maintainers" is disabled on that PR. These are 6 commits on top of fefbbea, the current head of
docs/64522-weekday-range:get_calendar().the_weekday()andthe_weekday_date().get_post_time()return type by date format.WP_Locale::get_weekday()as an int inwp_date().wp_date()when the timestamp cannot be parsed, with tests.WP_Locale::get_month().See the comment on WordPress#14827 for the reasoning behind each change and the PHPStan error breakdown. Merging this PR adds the commits to that PR.
Trac ticket: https://core.trac.wordpress.org/ticket/64522
🤖 Generated with Claude Code