has_custom_logo( int $blog_id = 0 ): bool
- Since
- 4.5.0
- Source
wp-includes/general-template.php:1238
Compatibility
- WordPress
- since 4.5.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$blog_idintoptional- ID of the blog in question. Default is the ID of the current blog.Default:
0
Return value
bool- Whether the site has a custom logo or not.
Performance profile
How much work a call to has_custom_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
- Light
- Scaling
- Constant
- Instructions
- 14–31
- Plugin surface
- None
- Called by
- 3
Only touches the object cache, via wp_cache_switch_to_blog().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 32.
Nothing here hands control to plugin code.
3 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
do_action()one call below has_custom_logo() - cacheobject cache
wp_cache_switch_to_blog()one call below has_custom_logo()
Further down the call graph this can also reach option, query, 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 · 12 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost has_custom_logo() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 14–16 | is_multisite(), get_theme_mod() |
| always | 16–18 | is_multisite(), get_theme_mod(), restore_current_blog() |
| always | 18–20 | is_multisite(), get_theme_mod(), wp_attachment_is_image() |
| always | 20–22 | is_multisite(), get_theme_mod(), wp_attachment_is_image(), restore_current_blog() |
is_multisite() && !empty($blog_id) | 21 | is_multisite(), get_current_blog_id(), get_theme_mod() |
is_multisite() && !empty($blog_id) | 23 | is_multisite(), get_current_blog_id(), get_theme_mod(), restore_current_blog() |
is_multisite() && !empty($blog_id) | 25 | is_multisite(), get_current_blog_id(), get_theme_mod(), wp_attachment_is_image() |
is_multisite() && !empty($blog_id) | 25 | is_multisite(), get_current_blog_id(), switch_to_blog(), get_theme_mod() |
is_multisite() && !empty($blog_id) | 27 | is_multisite(), get_current_blog_id(), get_theme_mod(), wp_attachment_is_image(), restore_current_blog() |
is_multisite() && !empty($blog_id) | 27 | is_multisite(), get_current_blog_id(), switch_to_blog(), get_theme_mod(), restore_current_blog() |
is_multisite() && !empty($blog_id) | 29 | is_multisite(), get_current_blog_id(), switch_to_blog(), get_theme_mod(), wp_attachment_is_image() |
is_multisite() && !empty($blog_id) | 31 | is_multisite(), get_current_blog_id(), switch_to_blog(), get_theme_mod(), wp_attachment_is_image(), restore_current_blog() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 31 | 14–30 | 5 | 1 fewer instruction than PHP 8.5 |
| 8.5 | 32 | 14–31 | 5 | |
| 8.4 | 32 | 14–31 | 5 | |
| 8.3 | 32 | 14–31 | 5 | |
| 8.2 | 32 | 14–31 | 5 | |
| 8.1 | 32 | 14–31 | 5 | |
| 7.4 | 32 | 14–31 | 5 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 6
- is_multisite()Determines whether Multisite is enabled.
- get_current_blog_id()Retrieves the current site ID.
- switch_to_blog()Switches the current blog.
- get_theme_mod()Retrieves theme modification value for the active theme.
- wp_attachment_is_image()Determines whether an attachment is an image.
- restore_current_blog()Restores the current blog, after calling switch_to_blog().
Used by · 3
- get_body_class()Retrieves an array of the class names for the body element.
- get_custom_logo()Returns a custom logo, linked to home unless the theme supports removing the link on the home page.
- twentytwenty_site_logo()Displays the site logo, either text or image.
Source code
function has_custom_logo( $blog_id = 0 ) { $switched_blog = false; if ( is_multisite() && ! empty( $blog_id ) && get_current_blog_id() !== (int) $blog_id ) { switch_to_blog( $blog_id ); $switched_blog = true; } $custom_logo_id = get_theme_mod( 'custom_logo' ); $is_image = ( $custom_logo_id ) ? wp_attachment_is_image( $custom_logo_id ) : false; if ( $switched_blog ) { restore_current_blog(); } return $is_image;}Changelog
Introduced in 4.5.0. Unchanged from 6.7.7 through 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.