is_protected_endpoint(): bool

Compatibility

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

Return value

bool

True if the current endpoint should be protected.

Performance profile

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

6–20

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

Plugin surface

1 hook

Third-party callbacks on 'is_protected_endpoint' 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

What one call costs · 6 distinct outcomes

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

Hooks and filters fired · 1

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

1. 1
   apply_filters( is_protected_endpoint )filterline 1204 (+28 into the body)

   Filters whether the current request is against a protected endpoint.

Uses · 4

• is_admin()Determines whether the current request is for an administrative interface page.
• wp_doing_ajax()Determines whether the current request is a WordPress Ajax request.
• is_protected_ajax_action()Determines whether we are currently handling an Ajax action that should be protected against WSODs.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 2

• WP_Fatal_Error_Handler::display_default_error_template()Displays the default PHP error template.
• WP_Recovery_Mode::handle_error()Handles a fatal error occurring.

Source code

View on Trac ↗View on GitHub ↗

1176function is_protected_endpoint() {1177	// Protect login pages.1178	if ( isset( $GLOBALS['pagenow'] ) && 'wp-login.php' === $GLOBALS['pagenow'] ) {1179		return true;1180	}1181 1182	// Protect the admin backend.1183	if ( is_admin() && ! wp_doing_ajax() ) {1184		return true;1185	}1186 1187	// Protect Ajax actions that could help resolve a fatal error should be available.1188	if ( is_protected_ajax_action() ) {1189		return true;1190	}1191 1192	/**1193	 * Filters whether the current request is against a protected endpoint.1194	 *1195	 * This filter is only fired when an endpoint is requested which is not already protected by1196	 * WordPress core. As such, it exclusively allows providing further protected endpoints in1197	 * addition to the admin backend, login pages and protected Ajax actions.1198	 *1199	 * @since 5.2.01200	 *1201	 * @param bool $is_protected_endpoint Whether the currently requested endpoint is protected.1202	 *                                    Default false.1203	 */1204	return (bool) apply_filters( 'is_protected_endpoint', false );1205}

Changelog

Introduced in 5.2.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 6.8.8 tag, from src/wp-includes/load.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.