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

Displays the Registration or Admin link.

Contents

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.

Top ↑

Parameters

$before string Optional
Text to output before the link. Default <li>.

Default: '<li>'

$after string Optional
Text to output after the link. Default </li>.

Default: '</li>'

$display bool Optional
Default to echo and not return the link.

Default: true

Top ↑

Return

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

Top ↑

More Information

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

 

Top ↑

Source

File: wp-includes/general-template.php. View all references 

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 on Trac View on GitHub

Top ↑

Hooks

Top ↑

Top ↑

Uses

Uses
Uses Description
wp_registration_url() wp-includes/general-template.php

Returns the URL that allows the user to register on the site.
current_user_can() wp-includes/capabilities.php

Returns whether the current user has the specified capability.
__() wp-includes/l10n.php

Retrieves the translation of $text.
esc_url() wp-includes/formatting.php

Checks and cleans a URL.
is_user_logged_in() wp-includes/pluggable.php

Determines whether the current visitor is a logged in user.
admin_url() wp-includes/link-template.php

Retrieves the URL to the admin area for the current site.
apply_filters() wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.
get_option() wp-includes/option.php

Retrieves an option value based on an option name.
Show 6 more uses Hide more uses

Top ↑

Changelog

Changelog
Version Description
1.5.0 Introduced.

Top ↑

User Contributed Notes

  2. Skip to note 2 content
    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
    Contributed by Codex —

    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>

You must log in before being able to contribute a note or feedback.