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

Description

Parameters

$beforestringoptional

Text to output before the link. Default &lt;li&gt;.Default: '<li>'

$afterstringoptional

Text to output after the link. Default &lt;/li&gt;.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.

Hooks fired · 1

One hook fires while wp_register() runs, in this order:

1. 1
   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

View on Trac ↗View on GitHub ↗

907function wp_register( $before = '<li>', $after = '</li>', $display = true ) {908	if ( ! is_user_logged_in() ) {909		if ( get_option( 'users_can_register' ) ) {910			$link = $before . '<a href="' . esc_url( wp_registration_url() ) . '">' . __( 'Register' ) . '</a>' . $after;911		} else {912			$link = '';913		}914	} elseif ( current_user_can( 'read' ) ) {915		$link = $before . '<a href="' . admin_url() . '">' . __( 'Site Admin' ) . '</a>' . $after;916	} else {917		$link = '';918	}919 920	/**921	 * Filters the HTML link to the Registration or Admin page.922	 *923	 * Users are sent to the admin page if logged-in, or the registration page924	 * if enabled and logged-out.925	 *926	 * @since 1.5.0927	 *928	 * @param string $link The HTML code for the link to the Registration or Admin page.929	 */930	$link = apply_filters( 'register', $link );931 932	if ( $display ) {933		echo $link;934	} else {935		return $link;936	}937}

History

Introduced in 1.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 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.