user_trailingslashit( string $url, string $type_of_url = '' ): string
- Since
- 2.2.0
- Source
wp-includes/link-template.php:47
Description
Conditionally adds a trailing slash if the permalink structure has a trailing slash, strips the trailing slash if not. The string is passed through the 'user_trailingslashit' filter. Will remove trailing slash from string, if site is not set to have them.
Compatibility
- WordPress
- since 2.2.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$urlstring- URL with or without a trailing slash.
$type_of_urlstringoptional- The type of URL being considered (e.g. single, category, etc) for use in the filter. Default empty string.Default:
''
Return value
string- The URL with the trailing slash appended or stripped.
Performance profile
How much work a call to user_trailingslashit() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Trivial
- Scaling
- Constant
- Instructions
- 15–16
- Plugin surface
- 1 hook
- Called by
- 29
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 20.
Third-party callbacks on 'user_trailingslashit' run inside this call, and their cost is not bounded by anything here.
29 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()called directly
What one call costs · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost user_trailingslashit() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!$wp_rewrite | 15 | untrailingslashit(), apply_filters() |
$wp_rewrite | 16 | trailingslashit(), apply_filters() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 20 instructions, 15–16 executed per call, 1 branch. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Hooks and filters fired · 1
One hook fires while user_trailingslashit() runs, in this order:
- apply_filters( user_trailingslashit )filterline 65 (+18 into the body)
Filters the trailing-slashed string, depending on whether the site is set to use trailing slashes.
Uses · 3
- trailingslashit()Appends a trailing slash.
- untrailingslashit()Removes trailing forward slashes and backslashes if they exist.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 29
- _get_page_link()Retrieves the page permalink.
- _wp_link_page()Helper function for wp_link_pages().
- get_attachment_link()Retrieves the permalink for an attachment.
- get_author_feed_link()Retrieves the feed link for a given author.
- get_author_posts_url()Retrieves the URL to the author page for the user with the ID provided.
- get_comment_link()Retrieves the link to a given comment.
- get_comments_pagenum_link()Retrieves the comments page number link.
- get_day_link()Retrieves the permalink for the day archives with year and month.
- get_feed_link()Retrieves the permalink for the feed type.
- get_index_rel_link()Get site index relational link.
- get_month_link()Retrieves the permalink for the month archives with year.
- get_pagenum_link()Retrieves the link for a page number.
Show all 29
- get_permalink()Retrieves the full permalink for the current post or post ID.
- get_post_comments_feed_link()Retrieves the permalink for the post comments feed.
- get_post_embed_url()Retrieves the URL to embed a specific post in an iframe.
- get_post_permalink()Retrieves the permalink for a post of a custom post type.
- get_post_type_archive_link()Retrieves the permalink for a post type archive.
- get_search_link()Retrieves the permalink for a search.
- get_term_feed_link()Retrieves the feed link for a term.
- get_term_link()Generates a permalink for a taxonomy term archive.
- get_trackback_url()Retrieves the current post's trackback URL.
- get_year_link()Retrieves the permalink for the year archives.
- paginate_comments_links()Displays or retrieves pagination links for the comments on the current post.
- paginate_links()Retrieves paginated links for archive post pages.
- redirect_canonical()Redirects incoming links to the proper URL based on the site url.
- redirect_guess_404_permalink()Attempts to guess the correct URL for a 404 request based on query vars.
- twentyfourteen_paging_nav()Displays navigation to next/previous set of posts when applicable.
- wp_get_canonical_url()Returns the canonical URL for a post.
- wp_old_slug_redirect()Redirect old slugs to the correct permalink.
Source code
function user_trailingslashit( $url, $type_of_url = '' ) { global $wp_rewrite; if ( $wp_rewrite->use_trailing_slashes ) { $url = trailingslashit( $url ); } else { $url = untrailingslashit( $url ); } /** * Filters the trailing-slashed string, depending on whether the site is set to use trailing slashes. * * @since 2.2.0 * * @param string $url URL with or without a trailing slash. * @param string $type_of_url The type of URL being considered. Accepts 'single', 'single_trackback', * 'single_feed', 'single_paged', 'commentpaged', 'paged', 'home', 'feed', * 'category', 'page', 'year', 'month', 'day', 'post_type_archive'. */ return apply_filters( 'user_trailingslashit', $url, $type_of_url );}Changelog
Introduced in 2.2.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/link-template.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.