wp_register() – Function | Developer.WordPress.org

Displays 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

$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

void|string Void if $display argument is true, registration or admin link if $display is false.

More Information

The “Register” link is not offered if the Administration > Settings > General > Membership: Anyone can register box is not checked.

Source

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;
	}
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘register’, string $link ): Filters the HTML link to the Registration or Admin page.

Uses	Description
wp_registration_url()`wp-includes/general-template.php`	Returns the URL that allows the user to register on the site.
admin_url()`wp-includes/link-template.php`	Retrieves the URL to the admin area for the current site.
current_user_can()`wp-includes/capabilities.php`	Returns whether the current user has the specified capability.
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.

Show 2 more Show less

Used by	Description
WP_Widget_Meta::widget()`wp-includes/widgets/class-wp-widget-meta.php`	Outputs the content for the current Meta widget instance.

Changelog

Version	Description
1.5.0	Introduced.

User Contributed Notes

Skip to note 3 content

Codex 10 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
Default Usage
wp_register displays the link in list format <li>.
```
<?php wp_register(); ?>
```
Log in to add feedback
Skip to note 4 content

Codex 10 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
Display Without Text Before or After
The following code example displays the “Register” or “Site Admin” link with no text in before or after parameters.
```
<?php wp_register('', ''); ?>
```
When not logged in the following HTML is produced:
```
<a href="http://www.example.com/wp-login.php?action=register">Register</a&gt;
```
When logged in the following HTML is produced:
```
<a href="http://www.example.com/wp-admin/">Site Admin</a>
```
Log in to add feedback

wp_register( string $before = '<li>', string $after = '</li>', bool $display = true ): void|string

In this article