Skip to content

[DEPRECATION] Param tags without name #362

Closed

Description

@jaapio

@param tag should always have a variable name in it's body, support for params without variable names will be dropped.

Supported formats will be: (option 3 does not really make any sense, but will be covered)

@param $var your description here
@param MyType $var your description
@param $var
@param MyType $var

Unsupported after this deprecation has been removed:

@param MyType your description here
@param MyType

Activity

  1. added this to the v6.0.0 milestone on Mar 20, 2024
  2. williamdes commented on Apr 6, 2024

    @williamdes
    Contributor

    And reported as invalid items I guess ?

  3. jaapio commented on Apr 8, 2024

    @jaapio
    MemberAuthor

    Yes these will be reported as InvalidTag

  4. norkunas commented on Apr 12, 2024

    @norkunas

    support for params without type ... will be dropped.

    so basically this is opposite to symfony/symfony#54523 ?

  5. williamdes commented on Apr 12, 2024

    @williamdes
    Contributor

    support for params without type ... will be dropped.

    so basically this is opposite to symfony/symfony#54523 ?

    the linked PR feels wrong, the types should always be present
    If the param do not document anything (type hints exist), drop them
    But if they do have a description, keep them in sync with native hints

    Anyway, that's only my point of view 😁

  6. jaapio commented on Apr 12, 2024

    @jaapio
    MemberAuthor

    Types are optional. I just noticed that the description of this issue is wrong. Thanks for the headsup @norkunas

  7. kkmuffme commented on Dec 7, 2025

    @kkmuffme

    @PARAM without a variable is extremely common for documentation of actions/filters in the WP ecosystem and found not only in WP itself but probably most plugins

  8. linked a pull request that will close this issuePrepare 6.x build #428on Dec 23, 2025
  9. removed a link to a pull requestPrepare 6.x build #428on Jan 1, 2026
  10. linked a pull request that will close this issuePrepare 6.x build #429on Jan 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions