WP_REST_Templates_Controller::get_wp_templates_author_text_field( WP_Block_Template $template_object ): string

Compatibility

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

Parameters

$template_objectWP_Block_Template

Template instance.

Return value

string

Human readable text for the author.

Performance profile

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

Heavy

Reaches the database via get_user_by().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

7–66

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

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

What it touches

• querycontent queryget_user_by()called directly
• optionoption read or writeget_option()one call below WP_REST_Templates_Controller::get_wp_templates_author_text_field()
• cacheobject cachewp_cache_get()one call below WP_REST_Templates_Controller::get_wp_templates_author_text_field()
• hookthird-party callbacksapply_filters()one call below WP_REST_Templates_Controller::get_wp_templates_author_text_field()

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

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

Uses · 11

• wp_get_theme()Gets a WP_Theme object for a theme.
• wp_get_active_and_valid_plugins()Retrieves an array of active and valid plugin files.
• plugin_basename()Gets the basename of a plugin.
• get_plugin_data()Parses the plugin contents to retrieve plugin's metadata.
• get_plugins()Checks the plugins directory and retrieve all plugin files with plugin data.
• sanitize_text_field()Sanitizes a string from user input or from the database.
• get_bloginfo()Retrieves information about the current site.
• get_user_by()Retrieves user info by a given field.
• __()Retrieves the translation of $text.
• WP_REST_Templates_Controller::get_wp_templates_original_source_field()Returns the source from where the template originally comes from.
• wp_get_theme($template_object->theme)::get()

Used by · 1

• WP_REST_Templates_Controller::prepare_item_for_response()Prepare a single template output for response

Source code

View on Trac ↗View on GitHub ↗

897	private static function get_wp_templates_author_text_field( $template_object ) {898		$original_source = self::get_wp_templates_original_source_field( $template_object );899		switch ( $original_source ) {900			case 'theme':901				$theme_name = wp_get_theme( $template_object->theme )->get( 'Name' );902				return empty( $theme_name ) ? $template_object->theme : $theme_name;903			case 'plugin':904				if ( ! function_exists( 'get_plugins' ) ) {905					require_once ABSPATH . 'wp-admin/includes/plugin.php';906				}907				if ( isset( $template_object->plugin ) ) {908					$plugins = wp_get_active_and_valid_plugins();909 910					foreach ( $plugins as $plugin_file ) {911						$plugin_basename = plugin_basename( $plugin_file );912						// Split basename by '/' to get the plugin slug.913						list( $plugin_slug, ) = explode( '/', $plugin_basename );914 915						if ( $plugin_slug === $template_object->plugin ) {916							$plugin_data = get_plugin_data( $plugin_file );917 918							if ( ! empty( $plugin_data['Name'] ) ) {919								return $plugin_data['Name'];920							}921 922							break;923						}924					}925				}926 927				/*928				 * Fall back to the theme name if the plugin is not defined. That's needed to keep backwards929				 * compatibility with templates that were registered before the plugin attribute was added.930				 */931				$plugins         = get_plugins();932				$plugin_basename = plugin_basename( sanitize_text_field( $template_object->theme . '.php' ) );933				if ( isset( $plugins[ $plugin_basename ] ) && isset( $plugins[ $plugin_basename ]['Name'] ) ) {934					return $plugins[ $plugin_basename ]['Name'];935				}936				return $template_object->plugin ??937					$template_object->theme;938			case 'site':939				return get_bloginfo( 'name' );940			case 'user':941				$author = get_user_by( 'id', $template_object->author );942				if ( ! $author ) {943					return __( 'Unknown author' );944				}945				return $author->get( 'display_name' );946		}947 948		// Fail-safe to return a string should the original source ever fall through.949		return '';950	}

Changelog

Introduced in 6.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/rest-api/endpoints/class-wp-rest-templates-controller.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.