wp_register( string $before = '<li>', string $after = '</li>', bool $display = true ): void|string
- Since
- 1.5.0
- Source
wp-includes/general-template.php:907
Description
Display a link which allows the user to navigate to the registration page if not logged in and registration is enabled or to the dashboard if logged in.
Compatibility
- WordPress
- since 1.5.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
$beforestringoptional- Text to output before the link. Default
<li>.Default:'<li>' $afterstringoptional- Text to output after the link. Default
</li>.Default:'</li>' $displaybooloptional- Default to echo and not return the link.Default:
true
Return value
void|string- Void if
$displayargument is true, registration or admin link if$displayis false.
Performance profile
How much work a call to wp_register() 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
- Moderate
- Scaling
- Constant
- Instructions
- 18–33
- Plugin surface
- 1 hook
- Called by
- 1
Reads stored settings via get_option(), cached per request but not free on a cold cache.
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 53.
Third-party callbacks on 'register' run inside this call, and their cost is not bounded by anything here.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- optionoption read or write
get_option()called directly - hookthird-party callbacks
apply_filters()called directly - cacheobject cache
wp_cache_get()one call below wp_register() - serializeserialisation
maybe_unserialize()one call below wp_register()
Further down the call graph this can also reach query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 4 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_register() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
is_user_logged_in() && !current_user_can() | 18–19 | is_user_logged_in(), current_user_can(), apply_filters() |
!is_user_logged_in() && !get_option() | 19–20 | is_user_logged_in(), get_option(), apply_filters() |
is_user_logged_in() && current_user_can() | 29–30 | is_user_logged_in(), current_user_can(), admin_url(), __(), apply_filters() |
!is_user_logged_in() && get_option() | 32–33 | is_user_logged_in(), get_option(), wp_registration_url(), esc_url(), __(), 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: 53 instructions, 18–33 executed per call, 4 branches. 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 wp_register() runs, in this order:
- apply_filters( register )filterline 930 (+23 into the body)
Filters the HTML link to the Registration or Admin page.
Uses · 8
- is_user_logged_in()Determines whether the current visitor is a logged in user.
- get_option()Retrieves an option value based on an option name.
- esc_url()Checks and cleans a URL.
- wp_registration_url()Returns the URL that allows the user to register on the site.
- __()Retrieves the translation of $text.
- current_user_can()Returns whether the current user has the specified capability.
- admin_url()Retrieves the URL to the admin area for the current site.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 1
- WP_Widget_Meta::widget()Outputs the content for the current Meta widget instance.
Source code
function wp_register( $before = '<li>', $after = '</li>', $display = true ) { if ( ! is_user_logged_in() ) { if ( get_option( 'users_can_register' ) ) { $link = $before . '<a href="' . esc_url( wp_registration_url() ) . '">' . __( 'Register' ) . '</a>' . $after; } else { $link = ''; } } elseif ( current_user_can( 'read' ) ) { $link = $before . '<a href="' . admin_url() . '">' . __( 'Site Admin' ) . '</a>' . $after; } else { $link = ''; } /** * Filters the HTML link to the Registration or Admin page. * * Users are sent to the admin page if logged-in, or the registration page * if enabled and logged-out. * * @since 1.5.0 * * @param string $link The HTML code for the link to the Registration or Admin page. */ $link = apply_filters( 'register', $link ); if ( $display ) { echo $link; } else { return $link; }}Changelog
Introduced in 1.5.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/general-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.