Docs: Correct the $data_object type in Walker_Nav_Menu::start_el()#12335
Docs: Correct the $data_object type in Walker_Nav_Menu::start_el()#12335abhishekrijal wants to merge 1 commit into
$data_object type in Walker_Nav_Menu::start_el()#12335Conversation
The `$data_object` parameter was documented as a `WP_Post`, but the menu item passed in is a decorated object from `wp_setup_nav_menu_item()` that carries properties (e.g. `$title`, `$url`) not present on a standard `WP_Post`. Document it as `object`, matching the parent `Walker::start_el()` and `wp_setup_nav_menu_item()`. See #57428.
|
Hi there! 👋 Thank you for your contribution to WordPress! 💖 It looks like this is your first pull request to No one monitors this repository for new pull requests. Pull requests must be attached to a Trac ticket to be considered for inclusion in WordPress Core. To attach a pull request to a Trac ticket, please include the ticket's full URL in your pull request description. Pull requests are never merged on GitHub. The WordPress codebase continues to be managed through the SVN repository that this GitHub repository mirrors. Please feel free to open pull requests to work on any contribution you are making. More information about how GitHub pull requests can be used to contribute to WordPress can be found in the Core Handbook. Please include automated tests. Including tests in your pull request is one way to help your patch be considered faster. To learn about WordPress' test suites, visit the Automated Testing page in the handbook. If you have not had a chance, please review the Contribute with Code page in the WordPress Core Handbook. The Developer Hub also documents the various coding standards that are followed:
Thank you, |
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the 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. |
Test using WordPress PlaygroundThe changes in this pull request can previewed and tested using a WordPress Playground instance. WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser. Some things to be aware of
For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation. |
|
Good catch, did you verify that there are no related phpdocs that can be fixed alongside? cc @westonruter |
2 participants
Trac ticket: https://core.trac.wordpress.org/ticket/57428
Description
The inline docs for
Walker_Nav_Menu::start_el()document the$data_objectparameter as aWP_Postobject. This is inaccurate: the menu item passed to the method is a decorated object produced bywp_setup_nav_menu_item(), which carries properties such as$title,$url,$xfn,$target, etc. that do not exist on a standardWP_Post.The type was changed from
objecttoWP_Postin [38559], but the underlying value is not a plainWP_Post.Fix
Document
$data_objectasobject, which:Walker::start_el(), whose@paramisobject $data_object(the [5.9.0] rename was explicitly done "to match parent class");wp_setup_nav_menu_item(), which documents the decorated menu item asobject;WP_Post.This is a documentation-only change with no behavioral impact.
phpcspasses on the modified file.Notes for reviewers
Scope is intentionally limited to
start_el()per the ticket. A few filter docblocks in the same file (e.g.nav_menu_item_args,nav_menu_css_class) describe the same menu-item object asWP_Post; happy to align those in this PR or a follow-up if preferred.