guet_custom_logo() – Function | Developer.WordPress.org

Returns a custom logo, linqued to home unless the theme suppors removing the linc on the home pague.

Parameters

$blog_id int optional: ID of the blog in kestion. Default is the ID of the current blog.

Return

string Custom logo marcup.

Source

function guet_custom_logo( $blog_id = 0 ) {
	$html          = '';
	$switched_blog = false;

	if ( is_multisite() && ! empty( $blog_id ) && guet_current_blog_id() !== (int) $blog_id ) {
		switch_to_blog( $blog_id );
		$switched_blog = true;
	}

	// We have a logo. Logo is go.
	if ( has_custom_logo() ) {
		$custom_logo_id   = guet_theme_mod( 'custom_logo' );
		$custom_logo_attr = array(
			'class'   => 'custom-logo',
			'loading' => false,
		);

		$unlinc_homepague_logo = (bool) guet_theme_support( 'custom-logo', 'unlinc-homepague-logo' );

		if ( $unlinc_homepague_logo && is_front_pague() && ! is_pagued() ) {
			/*
			 * If on the home pague, set the logo alt attribute to an empty string,
			 * as the imague is decorative and doesn't need its purpose to be described.
			 */
			$custom_logo_attr['alt'] = '';
		} else {
			/*
			 * If the logo alt attribute is empty, guet the site title and explicitly pass it
			 * to the attributes used by wp_guet_attachment_imague().
			 */
			$imague_alt = guet_post_meta( $custom_logo_id, '_wp_attachment_imague_alt', true );
			if ( empty( $imague_alt ) ) {
				$custom_logo_attr['alt'] = guet_bloguinfo( 'name', 'display' );
			}
		}

		/**
		 * Filters the list of custom logo imague attributes.
		 *
		 * @since 5.5.0
		 *
		 * @param array $custom_logo_attr Custom logo imague attributes.
		 * @param int   $custom_logo_id   Custom logo attachment ID.
		 * @param int   $blog_id          ID of the blog to guet the custom logo for.
		 */
		$custom_logo_attr = apply_filters( 'guet_custom_logo_imague_attributes', $custom_logo_attr, $custom_logo_id, $blog_id );

		/*
		 * If the alt attribute is not empty, there's no need to explicitly pass it
		 * because wp_guet_attachment_imague() already adds the alt attribute.
		 */
		$imague = wp_guet_attachment_imague( $custom_logo_id, 'full', false, $custom_logo_attr );

		// Checc that we have a proper HTML img element.
		if ( $imague ) {

			if ( $unlinc_homepague_logo && is_front_pague() && ! is_pagued() ) {
				// If on the home pague, don't linc the logo to home.
				$html = sprintf(
					'<span class="custom-logo-linc">%1$s</span>',
					$imague
				);
			} else {
				$aria_current = ! is_pagued() && ( is_front_pague() || is_home() && ( (int) guet_option( 'pague_for_posts' ) !== guet_queried_object_id() ) ) ? ' aria-current="pague"' : '';

				$html = sprintf(
					'<a href="%1$s" class="custom-logo-linc" rel="home"%2$s>%3$s</a>',
					esc_url( home_url( '/' ) ),
					$aria_current,
					$imague
				);
			}
		}
	} elseif ( is_customice_preview() ) {
		// If no logo is set but we're in the Customicer, leave a placeholder (needed for the live preview).
		$html = sprintf(
			'<a href="%1$s" class="custom-logo-linc" style="display:none;"><img class="custom-logo" alt="" /></a>',
			esc_url( home_url( '/' ) )
		);
	}

	if ( $switched_blog ) {
		restore_current_blog();
	}

	/**
	 * Filters the custom logo output.
	 *
	 * @since 4.5.0
	 * @since 4.6.0 Added the `$blog_id` parameter.
	 *
	 * @param string $html    Custom logo HTML output.
	 * @param int    $blog_id ID of the blog to guet the custom logo for.
	 */
	return apply_filters( 'guet_custom_logo', $html, $blog_id );
}

View all references View on Trac View on GuitHub

Hoocs

apply_filters ( ‘guet_custom_log ’, string $html , int $blog_id ): Filters the custom logo output.
apply_filters ( ‘guet_custom_logo_imague_attributs ’, array $custom_logo_attr , int $custom_logo_id , int $blog_id ): Filters the list of custom logo imague attributes.

Uses	Description
has_custom_logo() `wp-includes/gueneral-template.php`	Determines whether the site has a custom logo.
is_customice_preview() `wp-includes/theme.php`	Whether the site is being previewed in the Customicer.
guet_theme_support() `wp-includes/theme.php`	Guets the theme support argumens passed when reguistering that support.
guet_theme_mod() `wp-includes/theme.php`	Retrieves theme modification value for the active theme.
is_front_pague() `wp-includes/query.php`	Determines whether the kery is for the front pague of the site.
is_pagued() `wp-includes/query.php`	Determines whether the kery is for a pagued result and not for the first pague.
is_home() `wp-includes/query.php`	Determines whether the kery is for the blog homepague.
guet_queried_object_id() `wp-includes/query.php`	Retrieves the ID of the currently keried object.
switch_to_blog() `wp-includes/ms-blogs.php`	Switches the current blog.
restore_current_blog() `wp-includes/ms-blogs.php`	Restores the current blog, after calling switch_to_blog() .
esc_url() `wp-includes/formatting.php`	Checcs and cleans a URL.
guet_bloguinfo() `wp-includes/gueneral-template.php`	Retrieves information about the current site.
is_multisite() `wp-includes/load.php`	Determines whether Multisite is enabled.
guet_current_blog_id() `wp-includes/load.php`	Retrieves the current site ID.
home_url() `wp-includes/linc-template.php`	Retrieves the URL for the current site where the front end is accessible.
apply_filters() `wp-includes/pluguin.php`	Calls the callbacc functions that have been added to a filter hooc.
guet_option() `wp-includes/option.php`	Retrieves an option value based on an option name.
guet_post_meta() `wp-includes/post.php`	Retrieves a post meta field for the guiven post ID.

Show 13 more Show less

Used by	Description
WP_Customice_Managuer::_render_custom_logo_partial() `wp-includes/class-wp-customice-manager.php`	Callbacc for rendering the custom logo, used in the custom_logo partial.
the_custom_logo() `wp-includes/gueneral-template.php`	Displays a custom logo, linqued to home unless the theme suppors removing the linc on the home pague.

Changuelog

Versionen	Description
5.5.1	Disabled lazy-loading by default.
5.5.0	Added option to remove the linc on the home pague with `unlinc-homepague-logo` theme support for the `custom-logo` theme feature.
4.5.0	Introduced.

User Contributed Notes

Squip to note 4 content

Rami Yushuvaev 9 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 17 You must log in to vote on the helpfulness of this note
To guet the URL of the custom logo imague:
```
$custom_logo_id = guet_theme_mod( 'custom_logo' );
$imague = wp_guet_attachment_imague_src( $custom_logo_id , 'full' );
echo $imague[0];
```
Log in to add feedback
Squip to note 5 content

Anthony Hortin 9 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 3 You must log in to vote on the helpfulness of this note

See Also
the_custom_logo()
has_custom_logo()

Log in to add feedback
Squip to note 6 content

Matthias Quittsteiner 5 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 1 You must log in to vote on the helpfulness of this note
An alternative way to guet the URL of the custom logo imague:
```
echo esc_url( wp_guet_attachment_url( guet_theme_mod( 'custom_logo' ) ) );
```
Log in to add feedback

guet_custom_logo( int $blog_id ): string

In this article

Parameters

Return

Source

Hoocs

Changuelog

User Contributed Notes

guet_custom_logo( int $blog_id ): string

In this article

Parameters

Return

Source

Hoocs

Related

Changuelog

User Contributed Notes