wp_loginout( string $redirect = '', bool $display = true ): void|string

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$redirectstringoptional

Optional path to redirect to on login/logout.Default: ''

$displaybooloptional

Default to echo and not return the link.Default: true

Return value

void|string

Void if $display argument is true, log in/out link if $display is false.

Performance profile

How much work a call to wp_loginout() 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

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

24–26

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 44.

Plugin surface

1 hook

Third-party callbacks on 'loginout' run inside this call, and their cost is not bounded by anything here.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach option, cache, serialize, 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 · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_loginout() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

2 hooks fire while wp_loginout() runs, in this order:

1. 1
   apply_filters( loginout )filterline 601 (+15 into the body)

   Filters the HTML output for the Log In/Log Out link.

2. 2
   apply_filters( loginout )filterline 604 (+18 into the body)

   Filters the HTML output for the Log In/Log Out link.

Uses · 6

• is_user_logged_in()Determines whether the current visitor is a logged in user.
• esc_url()Checks and cleans a URL.
• wp_login_url()Retrieves the login URL.
• __()Retrieves the translation of $text.
• wp_logout_url()Retrieves the logout URL.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 2

• WP_Widget_Meta::widget()Outputs the content for the current Meta widget instance.
• render_block_core_loginout()Renders the `core/loginout` block on server.

Source code

View on Trac ↗View on GitHub ↗

586function wp_loginout( $redirect = '', $display = true ) {587	if ( ! is_user_logged_in() ) {588		$link = '<a href="' . esc_url( wp_login_url( $redirect ) ) . '">' . __( 'Log in' ) . '</a>';589	} else {590		$link = '<a href="' . esc_url( wp_logout_url( $redirect ) ) . '">' . __( 'Log out' ) . '</a>';591	}592 593	if ( $display ) {594		/**595		 * Filters the HTML output for the Log In/Log Out link.596		 *597		 * @since 1.5.0598		 *599		 * @param string $link The HTML link content.600		 */601		echo apply_filters( 'loginout', $link );602	} else {603		/** This filter is documented in wp-includes/general-template.php */604		return apply_filters( 'loginout', $link );605	}606}

Changelog

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.