twentytwenty_site_logo( array $args = array(), bool $display = true ): string|void

Compatibility

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

Parameters

$argsarrayoptional

Arguments for displaying the site logo either as an image or text.Default: array()

$displaybooloptional

Display or return the HTML.Default: true

Return value

string|void

Compiled HTML based on our arguments.

Performance profile

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

Moderate

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Constant

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

Instructions

39–106

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

Plugin surface

2 hooks

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

Called by

1

1 place 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
• optionoption read or writeget_option()called directly
• cacheobject cachewp_cache_get()one call below twentytwenty_site_logo()
• serializeserialisationmaybe_unserialize()one call below twentytwenty_site_logo()

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

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

Hooks and filters fired · 2

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

1. 1
   apply_filters( twentytwenty_site_logo_args )filterline 60 (+26 into the body)

   Filters the arguments for `twentytwenty_site_logo()`.

2. 2
   apply_filters( twentytwenty_site_logo )filterline 95 (+61 into the body)

   Filters the arguments for `twentytwenty_site_logo()`.

Uses · 14

• get_custom_logo()Returns a custom logo, linked to home unless the theme supports removing the link on the home page.
• get_bloginfo()Retrieves information about the current site.
• is_front_page()Determines whether the query is for the front page of the site.
• is_home()Determines whether the query is for the blog homepage.
• is_page()Determines whether the query is for an existing single page.
• wp_parse_args()Merges user defined arguments into defaults array.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• has_custom_logo()Determines whether the site has a custom logo.
• esc_html()Escaping for HTML blocks.
• esc_url()Checks and cleans a URL.
• get_home_url()Retrieves the URL for a given site where the front end is accessible.
• get_option()Retrieves an option value based on an option name.

Used by · 1

• twentytwenty_customize_partial_site_logo()Renders the site logo for the selective refresh partial.

Source code

View on Trac ↗View on GitHub ↗

34function twentytwenty_site_logo( $args = array(), $display = true ) {35	$logo       = get_custom_logo();36	$site_title = get_bloginfo( 'name' );37	$contents   = '';38	$classname  = '';39 40	$defaults = array(41		'logo'        => '%1$s<span class="screen-reader-text">%2$s</span>',42		'logo_class'  => 'site-logo',43		'title'       => '<a href="%1$s" rel="home">%2$s</a>',44		'title_class' => 'site-title',45		'home_wrap'   => '<h1 class="%1$s">%2$s</h1>',46		'single_wrap' => '<div class="%1$s faux-heading">%2$s</div>',47		'condition'   => ( is_front_page() || is_home() ) && ! is_page(),48	);49 50	$args = wp_parse_args( $args, $defaults );51 52	/**53	 * Filters the arguments for `twentytwenty_site_logo()`.54	 *55	 * @since Twenty Twenty 1.056	 *57	 * @param array $args     Parsed arguments.58	 * @param array $defaults Function's default arguments.59	 */60	$args = apply_filters( 'twentytwenty_site_logo_args', $args, $defaults );61 62	if ( has_custom_logo() ) {63		$contents  = sprintf( $args['logo'], $logo, esc_html( $site_title ) );64		$classname = $args['logo_class'];65	} else {66		if ( ! $site_title ) {67			return '';68		}69 70		$contents = sprintf( $args['title'], esc_url( get_home_url( null, '/' ) ), esc_html( $site_title ) );71		if (72			( is_front_page() || is_home() && ( (int) get_option( 'page_for_posts' ) !== get_queried_object_id() ) )73			&& ! is_paged()74			&& $args['title'] === $defaults['title']75		) {76			$contents = str_replace( ' rel=', ' aria-current="page" rel=', $contents );77		}78		$classname = $args['title_class'];79	}80 81	$wrap = $args['condition'] ? 'home_wrap' : 'single_wrap';82 83	$html = sprintf( $args[ $wrap ], $classname, $contents );84 85	/**86	 * Filters the arguments for `twentytwenty_site_logo()`.87	 *88	 * @since Twenty Twenty 1.089	 *90	 * @param string $html      Compiled HTML based on our arguments.91	 * @param array  $args      Parsed arguments.92	 * @param string $classname Class name based on current view, home or single.93	 * @param string $contents  HTML for site title or logo.94	 */95	$html = apply_filters( 'twentytwenty_site_logo', $html, $args, $classname, $contents );96 97	if ( ! $display ) {98		return $html;99	}100 101	echo $html;102}

Changelog

Introduced in Twenty Twenty 1.0. One change between 6.7.7 and 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-content/themes/twentytwenty/inc/template-tags.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.