-
Notifications
You must be signed in to change notification settings - Fork 2.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Remove any title
attribute from the_shortlink()
#8159
base: trunk
Are you sure you want to change the base?
Conversation
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. |
src/wp-includes/link-template.php
Outdated
|
||
/** | ||
* Filters the short link anchor tag for a post. | ||
* | ||
* @since 3.0.0 | ||
* @since 6.8.0 Removed title attribute. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The title attribute isn't removed from the filter, so I don't think this @SInCE reference is needed.
src/wp-includes/link-template.php
Outdated
* | ||
* @param string $link Shortlink anchor tag. | ||
* @param string $shortlink Shortlink URL. | ||
* @param string $text Shortlink's text. | ||
* @param string $title Shortlink's title attribute. | ||
* @param string $title Unused. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the context of the filter, I think this parameter should say something like "Custom title attribute. Unused." For any extender wishing to retain the title attribute, this is the relevant documentation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Custom" could be fine, but I just restored "Shortlink's title attribute."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me. Only added a small enhancement proposal for the default value.
* @param string $text Optional. The link text or HTML to be displayed. Defaults to 'This is the short link.' | ||
* @param string $title Unused. | ||
* @param string $before Optional. HTML to display before the link. Default empty. | ||
* @param string $after Optional. HTML to display after the link. Default empty. | ||
*/ | ||
function the_shortlink( $text = '', $title = '', $before = '', $after = '' ) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd assign null
value to $title
as in other occurrences in core, for consistency.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would the docblock need to declare both types (string|null
) if the default changes?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm good question. That's not the case in lazyload_meta_callback()
and on the other use cas I found (and some other case don't nullify the value)… maybe we should just keep your base implementation 🤷
Option 1: Removes any
title
attribute from the shortlink output, and updates documentation.Trac 62838
This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.