wp_register( string $before = '<li>', string $after = '</li>', bool $echo = true )
Display the Registration or Admin link.
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.
Parameters
- $before
-
(Optional) Text to output before the link. Default
<li>
.Default value: '<li>'
- $after
-
(Optional) Text to output after the link. Default
</li>
.Default value: '</li>'
- $echo
-
(Optional) Default to echo and not return the link.
Default value: true
Return
(string|void) String when retrieving.
Source
File: wp-includes/general-template.php
function wp_register( $before = '<li>', $after = '</li>', $echo = 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 WP-1.5.0
*
* @param string $link The HTML code for the link to the Registration or Admin page.
*/
$link = apply_filters( 'register', $link );
if ( $echo ) {
echo $link;
} else {
return $link;
}
}
Changelog
Version | Description |
---|---|
WP-1.5.0 | Introduced. |