Page MenuHomePhabricator
Create Task
Maniphest T204307

Parser Functions should support named parameters
Open, Needs TriagePublic
Actions

Description

To quote https://www.mediawiki.org/wiki/Manual:Parser_functions#Named_parameters :

Parser functions do not support named parameters the way templates and tag extensions do, but it is occasionally useful to fake it.

For uniformity of template syntax parsing, and to prevent continued slightly-incompatible wheel reinvention, we should fix this. When a parser function is registered with SFH_NAMED_ARGS as a flag to [Parser::setFunctionHook](https://www.mediawiki.org/wiki/Manual:Parser_functions#The_setFunctionHook_hook) standardized parsing of named arguments should be done by core. Users should be encouraged to migrate to this.

We should think carefully through the desired behavior for whitespace-stripping of argument values, and ensure it makes sense with T114432: [RFC] Heredoc arguments for templates (aka "hygienic" or "long" arguments).

(Note that argument values for extension tags is whitespace-stripped in core, which is arguably a misfeature: T267974#6625861 )

Details

Related Changes in Gerrit:
SubjectRepoBranchLines +/-
Bump wikimedia/parsoid to 0.23.0-a8mediawiki/vendormaster+296 -166
Bump wikimedia/parsoid to 0.23.0-a7mediawiki/vendorwmf/1.46.0-wmf.4+42 -20
Bump wikimedia/parsoid to 0.23.0-a7mediawiki/vendormaster+42 -20
Handle deserialization of old parser functions with named argumentsmediawiki/services/parsoidmaster+22 -0
Bump wikimedia/parsoid to 0.22.0-a21mediawiki/vendormaster+26 K -23 K
Consider all pf arguments as positionalmediawiki/services/parsoidmaster+71 -29
WIP: Add parser function support to Parsoidmediawiki/services/parsoidmaster+1 K -27
Bump wikimedia/parsoid to 0.21.0-a24mediawiki/vendormaster+2 K -339
FragmentHandler: new parser function APImediawiki/services/parsoidmaster+1 K -53
Customize query in gerrit

Related Objects
Search...

Event Timeline

cscott created this task.Sep 14 2018, 9:29 AM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptSep 14 2018, 9:29 AM
cscott mentioned this in T114432: [RFC] Heredoc arguments for templates (aka "hygienic" or "long" arguments).Sep 14 2018, 9:41 AM
Anomie subscribed.Sep 14 2018, 3:58 PM

I note that the code at that link seems a bit outdated. A parser function that wants named arguments today should probably use SFH_OBJECT_ARGS and use PPNode->splitArg(), more or less like PPFrame_Hash::newChild() does or like Parser::braceSubstitution() does for special page transclusion.

That's not to oppose this task, I think a new SFH_NAMED_ARGS flag to make it even easier for implementers would be a good idea.

cscott added a comment.Sep 14 2018, 4:49 PM

Thanks for the feedback!

cscott mentioned this in T204371: Replace initial colon in (hash-prefixed) parser function invocation with vertical bar.Sep 14 2018, 5:28 PM

When opting in to "standard" named argument parsing, you might want to opt-in to replacing the first colon with a vertical bar to look even more like a "standard" template invocation: T204371: Replace initial colon in (hash-prefixed) parser function invocation with vertical bar.

ssastry moved this task from Backlog to Wikitext new features on the MediaWiki-Parser board.Sep 17 2018, 3:22 PM
ssastry moved this task from Needs Triage to Future Ideas on the Parsoid board.Sep 17 2018, 7:34 PM
cscott mentioned this in T230653: Use a parser function to encapsulate signatures.Sep 17 2019, 4:41 PM
Aklapper removed a subscriber: Anomie.Oct 16 2020, 5:01 PM
cscott mentioned this in T267974: Some linebreak chars in <ref>'s name attribute (and possibly other attributes as well) not handled correctly by Parsoid's Cite implementation.Nov 16 2020, 10:40 PM
cscott updated the task description. (Show Details)Nov 17 2020, 1:20 AM
Aklapper removed cscott as the assignee of this task.Dec 19 2020, 11:24 AM

Removing task assignee due to inactivity, as this open task has been assigned to the same person for more than two years (see the emails sent to the task assignee on Oct27 and Nov23). Please assign this task to yourself again if you still realistically [plan to] work on this task - it would be welcome.
(See https://www.mediawiki.org/wiki/Bug_management/Assignee_cleanup for tips how to best manage your individual work in Phabricator.)

Ltrlg subscribed.Jan 20 2021, 8:07 AM
RobinHood70 subscribed.May 26 2021, 3:30 AM
ExE-Boss subscribed.Jun 4 2021, 7:07 AM
cscott mentioned this in T268144: Add setFunctionHook equivalent support to Parsoid Extension API.Feb 11 2022, 4:32 PM
gerritbot added a comment.Feb 16 2022, 11:36 PM

Change 761494 had a related patch set uploaded (by Subramanya Sastry; author: Subramanya Sastry):

[mediawiki/services/parsoid@master] WIP: Add parser function support to Parsoid

https://gerrit.wikimedia.org/r/761494

gerritbot added a project: Patch-For-Review.Feb 16 2022, 11:36 PM
cscott mentioned this in T55413: TemplateData: Consider support for non-template transclusions (magic words, parser functions).Aug 1 2022, 6:06 PM
Aklapper removed a subscriber: Parsing-Team--ARCHIVED.May 24 2023, 1:09 PM
Pppery edited projects, added Patch-Needs-Improvement; removed Patch-For-Review.Jun 14 2024, 6:40 PM
cscott mentioned this in T377557: Parsoid interprets "X=..." in a parser function body as an key/value pair.Oct 30 2024, 8:29 PM
gerritbot added a comment.Mar 17 2025, 6:11 AM

Change #1087277 had a related patch set uploaded (by C. Scott Ananian; author: C. Scott Ananian):

[mediawiki/services/parsoid@master] WIP: FragmentHandler (new parser function API)

https://gerrit.wikimedia.org/r/1087277

gerritbot added a project: Patch-For-Review.Mar 17 2025, 6:11 AM
Restricted Application removed a project: Patch-Needs-Improvement. · View Herald TranscriptMar 17 2025, 6:11 AM
gerritbot added a comment.Apr 4 2025, 3:30 AM

Change #1087277 merged by jenkins-bot:

[mediawiki/services/parsoid@master] FragmentHandler: new parser function API

https://gerrit.wikimedia.org/r/1087277

gerritbot added a comment.Apr 4 2025, 1:04 PM

Change #1134218 had a related patch set uploaded (by C. Scott Ananian; author: C. Scott Ananian):

[mediawiki/vendor@master] Bump wikimedia/parsoid to 0.21.0-a24

https://gerrit.wikimedia.org/r/1134218

gerritbot added a comment.Apr 4 2025, 1:26 PM

Change #1134218 merged by jenkins-bot:

[mediawiki/vendor@master] Bump wikimedia/parsoid to 0.21.0-a24

https://gerrit.wikimedia.org/r/1134218

cscott added a subtask: T390344: v3 parserfunction serialization doesn't properly support named arguments.Apr 4 2025, 3:30 PM
cscott mentioned this in T390344: v3 parserfunction serialization doesn't properly support named arguments.
gerritbot added a comment.Apr 9 2025, 2:54 AM

Change #761494 abandoned by Subramanya Sastry:

[mediawiki/services/parsoid@master] WIP: Add parser function support to Parsoid

https://gerrit.wikimedia.org/r/761494

Alex44019 subscribed.Apr 27 2025, 5:47 AM
cscott added a subtask: T392085: PHP Warning: Undefined array key 27.May 22 2025, 2:14 PM
cscott added a parent task: T72077: Order of named parameters passed to parser functions is lost.May 27 2025, 2:12 PM
cscott mentioned this in T392085: PHP Warning: Undefined array key 27.May 29 2025, 2:47 PM
gerritbot added a comment.Sep 11 2025, 12:20 AM

Change #1186634 had a related patch set uploaded (by Arlolra; author: Arlolra):

[mediawiki/services/parsoid@master] Consider all pf arguments as positional

https://gerrit.wikimedia.org/r/1186634

gerritbot added a comment.Sep 11 2025, 10:29 PM

Change #1186634 merged by jenkins-bot:

[mediawiki/services/parsoid@master] Consider all pf arguments as positional

https://gerrit.wikimedia.org/r/1186634

gerritbot added a comment.Sep 12 2025, 3:00 PM

Change #1187841 had a related patch set uploaded (by C. Scott Ananian; author: C. Scott Ananian):

[mediawiki/vendor@master] Bump wikimedia/parsoid to 0.22.0-a21

https://gerrit.wikimedia.org/r/1187841

gerritbot added a comment.Sep 12 2025, 3:44 PM

Change #1187841 merged by jenkins-bot:

[mediawiki/vendor@master] Bump wikimedia/parsoid to 0.22.0-a21

https://gerrit.wikimedia.org/r/1187841

gerritbot added a comment.Nov 25 2025, 3:53 AM

Change #1210839 had a related patch set uploaded (by C. Scott Ananian; author: C. Scott Ananian):

[mediawiki/services/parsoid@master] Handle deserialization of old parser functions with named arguments

https://gerrit.wikimedia.org/r/1210839

gerritbot added a comment.Nov 26 2025, 4:11 PM

Change #1210839 merged by jenkins-bot:

[mediawiki/services/parsoid@master] Handle deserialization of old parser functions with named arguments

https://gerrit.wikimedia.org/r/1210839

gerritbot added a comment.Nov 26 2025, 4:46 PM

Change #1211724 had a related patch set uploaded (by C. Scott Ananian; author: C. Scott Ananian):

[mediawiki/vendor@master] Bump wikimedia/parsoid to 0.23.0-a7

https://gerrit.wikimedia.org/r/1211724

gerritbot added a comment.Nov 26 2025, 5:27 PM

Change #1211724 merged by jenkins-bot:

[mediawiki/vendor@master] Bump wikimedia/parsoid to 0.23.0-a7

https://gerrit.wikimedia.org/r/1211724

gerritbot added a comment.Nov 26 2025, 7:32 PM

Change #1211759 had a related patch set uploaded (by C. Scott Ananian; author: C. Scott Ananian):

[mediawiki/vendor@wmf/1.46.0-wmf.4] Bump wikimedia/parsoid to 0.23.0-a7

https://gerrit.wikimedia.org/r/1211759

gerritbot added a comment.Nov 26 2025, 9:19 PM

Change #1211759 merged by jenkins-bot:

[mediawiki/vendor@wmf/1.46.0-wmf.4] Bump wikimedia/parsoid to 0.23.0-a7

https://gerrit.wikimedia.org/r/1211759

Stashbot added a comment.Nov 26 2025, 9:19 PM

Mentioned in SAL (#wikimedia-operations) [2025-11-26T21:19:45Z] <cscott@deploy2002> Started scap sync-world: Backport for [[gerrit:1211759|Bump wikimedia/parsoid to 0.23.0-a7 (T204307 T373253 T410826 T410960)]], [[gerrit:1211760|Bump wikimedia/parsoid to 0.23.0-a7 (T410960)]]

Stashbot mentioned this in T373253: Develop semantic / distinct representation for wikifunctions output in Parsoid DOM.Nov 26 2025, 9:19 PM
Stashbot mentioned this in T410826: UnexpectedValueException: Unable to decode data-mw [{"parts":[{"template":{"target":{"wt":"#ifexpr: {{#expr:{{CURRENTMONTH}} = 4}} and {{#expr:{{CURRENTDAY}} = 1}}","function":"ifexpr"},"params":{"1":{"wt":"<div class=\"usermes.
Stashbot mentioned this in T410960: CTT tasks week of 2025-11-21.
Stashbot added a comment.Nov 26 2025, 9:21 PM

Mentioned in SAL (#wikimedia-operations) [2025-11-26T21:21:56Z] <cscott@deploy2002> cscott: Backport for [[gerrit:1211759|Bump wikimedia/parsoid to 0.23.0-a7 (T204307 T373253 T410826 T410960)]], [[gerrit:1211760|Bump wikimedia/parsoid to 0.23.0-a7 (T410960)]] synced to the testservers (see https://wikitech.wikimedia.org/wiki/Mwdebug). Changes can now be verified there.

Stashbot added a comment.Nov 26 2025, 9:32 PM

Mentioned in SAL (#wikimedia-operations) [2025-11-26T21:32:23Z] <cscott@deploy2002> Finished scap sync-world: Backport for [[gerrit:1211759|Bump wikimedia/parsoid to 0.23.0-a7 (T204307 T373253 T410826 T410960)]], [[gerrit:1211760|Bump wikimedia/parsoid to 0.23.0-a7 (T410960)]] (duration: 12m 38s)

gerritbot added a comment.Dec 1 2025, 5:29 PM

Change #1213536 had a related patch set uploaded (by Isabelle Hurbain-Palatin; author: Isabelle Hurbain-Palatin):

[mediawiki/vendor@master] Bump wikimedia/parsoid to 0.23.0-a8

https://gerrit.wikimedia.org/r/1213536

gerritbot added a comment.Dec 1 2025, 6:06 PM

Change #1213536 merged by jenkins-bot:

[mediawiki/vendor@master] Bump wikimedia/parsoid to 0.23.0-a8

https://gerrit.wikimedia.org/r/1213536

Mr._Starfleet_Command subscribed.Dec 14 2025, 4:32 AM
cscott closed subtask T390344: v3 parserfunction serialization doesn't properly support named arguments as Resolved.Feb 9 2026, 6:43 PM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits