File: /home/ukpics.org.uk/public_html-20250117120744/wp-content/themes/bloglo/inc/helpers.php
<?php
/**
* Frontend helper functions used throught the theme.
*
* @package Bloglo
* @author Peregrine Themes
* @since 1.0.0
*/
/**
* Do not allow direct script access.
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* Returns current page URL.
*
* @since 1.0.0
* @return string, current page URL.
*/
function bloglo_current_url() {
global $wp;
return home_url( add_query_arg( array(), $wp->request ) );
}
/**
* Returns site URL.
*
* @since 1.0.0
* @return string, current page URL.
*/
function bloglo_get_site_url() {
return apply_filters( 'bloglo_site_url', home_url( '/' ) );
}
/**
* Returns site title.
*
* @since 1.0.0
* @return string, current page URL.
*/
function bloglo_get_site_title() {
return apply_filters( 'bloglo_site_title', get_bloginfo( 'name' ) );
}
/**
* Returns site description.
*
* @since 1.0.0
* @return string, current page URL.
*/
function bloglo_get_site_description() {
return apply_filters( 'bloglo_site_description', get_bloginfo( 'description' ) );
}
if ( ! function_exists( 'bloglo_the_title' ) ) {
/**
* Wrapper function for bloglo_get_the_title().
*
* @since 1.0.0
* @param string $before Optional. Content to prepend to the title.
* @param string $after Optional. Content to append to the title.
* @param int $post_id Optional, default to 0. Post id.
* @param bool $echo Optional, default to true. Whether to display or return.
* @return string|void String if $echo parameter is false.
*/
function bloglo_the_title( $before = '', $after = '', $post_id = 0, $echo = true ) {
$title = bloglo_get_the_title( $post_id );
$before = apply_filters( 'bloglo_the_title_before', $before );
$after = apply_filters( 'bloglo_the_title_after', $after );
$title = $before . $title . $after;
if ( $echo ) {
echo wp_kses( $title, bloglo_get_allowed_html_tags() );
} else {
return $title;
}
}
}
if ( ! function_exists( 'bloglo_get_the_title' ) ) {
/**
* Get page title. Adds support for non-singular pages.
*
* @since 1.0.0
* @param int $post_id Optional, default to 0. Post id.
* @param bool $echo Optional, default to false. Whether to display or return.
* @return string|void String if $echo parameter is false.
*/
function bloglo_get_the_title( $post_id = 0, $echo = false ) {
$title = '';
if ( $post_id || is_singular() ) {
$title = get_the_title( $post_id );
if ( function_exists( 'yith_wcwl_is_wishlist_page' ) && yith_wcwl_is_wishlist_page() ) {
// Retireve wishlist title.
$wishlist_title = get_option( 'yith_wcwl_wishlist_title' ) ? get_option( 'yith_wcwl_wishlist_title' ) : __( 'Wishlist', 'bloglo' );
// Yith wishlist title.
$title = apply_filters( 'bloglo_yith_wishlist_title', esc_html( $wishlist_title ) );
}
} else {
if ( is_front_page() && is_home() ) {
// Homepage.
$title = apply_filters( 'bloglo_home_page_title', esc_html__( 'Home', 'bloglo' ) );
} elseif ( is_home() ) {
// Blog page.
$title = apply_filters( 'bloglo_blog_page_title', get_the_title( get_option( 'page_for_posts', true ) ) );
} elseif ( is_404() ) {
// 404 page - title always display.
$title = apply_filters( 'bloglo_404_page_title', esc_html__( 'This page doesn’t seem to exist.', 'bloglo' ) );
} elseif ( is_search() ) {
// Search page - title always display.
/* translators: 1: search string */
$title = apply_filters( 'bloglo_search_page_title', sprintf( __( 'Search results for: %s', 'bloglo' ), get_search_query() ) );
} elseif ( class_exists( 'WooCommerce' ) && is_shop() ) {
// Woocommerce.
$title = woocommerce_page_title( false );
} elseif ( is_author() ) {
// Author post archive.
$title = apply_filters( 'bloglo_author_page_title', esc_html__( 'Posts by', 'bloglo' ) . ' ' . esc_html( get_the_author() ) );
} elseif ( is_category() || is_tag() || is_tax() ) {
// Category, tag and custom taxonomy archive.
$title = single_term_title( '', false );
} elseif ( is_archive() ) {
// Archive.
$title = get_the_archive_title();
}
}
if ( $echo ) {
echo wp_kses( $title, bloglo_get_allowed_html_tags() );
} else {
return $title;
}
}
}
if ( ! function_exists( 'bloglo_get_the_id' ) ) {
/**
* Get post ID.
*
* @since 1.0.0
* @return string Current post/page ID.
*/
function bloglo_get_the_id() {
$post_id = 0;
if ( is_home() && 'page' === get_option( 'show_on_front' ) ) {
$post_id = get_option( 'page_for_posts' );
} elseif ( is_front_page() && 'page' === get_option( 'show_on_front' ) ) {
$post_id = get_option( 'page_on_front' );
} elseif ( is_singular() ) {
$post_id = get_the_ID();
}
return apply_filters( 'bloglo_get_the_id', $post_id );
}
}
if ( ! function_exists( 'bloglo_get_the_description' ) ) {
/**
* Get page description. Adds support for non-singular pages.
*
* @since 1.0.0
* @param int $post_id Optional, default to 0. Post id.
* @param bool $echo Optional, default to false. Whether to display or return.
* @return string|void String if $echo parameter is false.
*/
function bloglo_get_the_description( $post_id = 0, $echo = false ) {
$description = '';
if ( $post_id ) {
// @todo: take from meta..
$description = get_the_excerpt( $post_id );
} elseif ( is_search() ) {
global $wp_query;
$found_posts = $wp_query->found_posts;
if ( $found_posts > 0 ) {
// Translators: $s number of found results.
$description = sprintf( _n( '%s result found', '%s results found', $found_posts, 'bloglo' ), number_format_i18n( $found_posts ) );
} else {
$description = esc_html__( 'No results found', 'bloglo' );
}
} elseif ( is_author() ) {
$description = '';
} else {
$description = get_the_archive_description();
}
if ( $echo ) {
echo esc_html( $description );
} else {
return $description;
}
}
}
/**
* Checks to see if we're on the homepage or not.
*
* @since 1.0.0
* @return boolean, if current page is front page.
*/
function bloglo_is_frontpage() {
return ( is_front_page() && ! is_home() );
}
/**
* Check if schema is enabled.
*
* @since 1.0.0
* @return boolean
*/
function bloglo_is_schema_enabled() {
$enabled = bloglo_option( 'enable_schema' );
return apply_filters( 'bloglo_is_schema_enabled', $enabled );
}
/**
* Check if a custom logo has been uploaded.
*
* @since 1.0.0
* @return boolean
*/
function bloglo_has_logo() {
if ( has_custom_logo() ) {
return true;
}
return false;
}
/**
* Get sidebar name.
*
* @since 1.0.0
* @return string|boolean
*/
function bloglo_get_sidebar() {
$sidebar = 'sidebar-1';
$sidebar = apply_filters( 'bloglo_sidebar_name', $sidebar );
if ( ! is_active_sidebar( $sidebar ) && ! current_user_can( 'edit_theme_options' ) ) {
return false;
}
return $sidebar;
}
/**
* Get site layout (content layout) position.
*
* @since 1.0.0
* @param object|int|null $post Optional. The post to check. If not supplied, defaults to the current post if used in the loop.
* @return string, site layout.
*/
function bloglo_get_site_layout( $post = null ) {
// Default site layout from Customizer.
$default_site_layout = apply_filters( 'bloglo_default_site_layout', bloglo_option( 'site_layout' ), $post );
$site_layout = $default_site_layout;
$post = is_null( $post ) ? bloglo_get_the_id() : $post;
if ( $post ) {
$post = get_post( $post );
// Singular pages have meta settings for content layout.
if ( ! empty( $post ) ) {
$site_layout = get_post_meta( $post->ID, 'bloglo_content_layout', true );
if ( empty( $site_layout ) ) {
$site_layout = $default_site_layout;
}
}
}
return apply_filters( 'bloglo_site_layout', $site_layout );
}
/**
* Get sidebar layout position.
*
* @since 1.0.0
* @param object|int|null $post Optional. The post to check. If not supplied, defaults to the current post if used in the loop.
* @return string, Sidebar layout position.
*/
function bloglo_get_sidebar_position( $post = null ) {
// Default sidebar position.
if ( is_singular( 'post' ) ) {
$default_sidebar_position = bloglo_option( 'single_post_sidebar_position' );
} elseif ( is_singular( 'page' ) ) {
$default_sidebar_position = bloglo_option( 'single_page_sidebar_position' );
} elseif ( is_archive() || is_search() ) {
$default_sidebar_position = bloglo_option( 'archive_sidebar_position' );
} else {
$default_sidebar_position = bloglo_option( 'sidebar_position' );
}
if ( empty( $default_sidebar_position ) || 'default' === $default_sidebar_position ) {
$default_sidebar_position = bloglo_option( 'sidebar_position' );
}
$post = is_null( $post ) ? bloglo_get_the_id() : $post;
$default_sidebar_position = apply_filters( 'bloglo_default_sidebar_position', $default_sidebar_position, $post );
$sidebar_position = $default_sidebar_position;
// Get meta settings if page is set.
if ( $post ) {
$post = get_post( $post );
// Singular pages have meta settings for sidebar position.
if ( ! empty( $post ) ) {
$sidebar_position = get_post_meta( $post->ID, 'bloglo_sidebar_position', true );
if ( empty( $sidebar_position ) ) {
$sidebar_position = $default_sidebar_position;
}
}
}
// Force no sidebar on 404 pages.
if ( is_404() ) {
$sidebar_position = 'no-sidebar';
}
return apply_filters( 'bloglo_sidebar_position', $sidebar_position, $post );
}
/**
* Check if sidebar is displayed.
*
* @since 1.0.0
* @param int $post Optional. The post ID to check. If not supplied, defaults to the current post if used in the loop.
* @return boolean Sidebar displayed.
*/
function bloglo_is_sidebar_displayed( $post = null ) {
$position = bloglo_get_sidebar_position( $post );
$displayed = true;
if ( 'no-sidebar' === $position || '' === $position || false === $position ) {
$displayed = false;
}
if ( ! bloglo_get_sidebar() ) {
$displayed = false;
}
return apply_filters( 'bloglo_is_sidebar_displayed', $displayed );
}
/**
* Check if sidebar is displayed.
*
* @since 1.0.0
* @return string Article feed layout slug.
*/
function bloglo_get_article_feed_layout() {
$layout = '';
if ( is_page_template( 'page-templates/template-blog-masonry.php' ) || is_front_page() || is_home() || is_archive() || is_search() ) {
$layout = bloglo_option( 'blog_layout' );
}
return apply_filters( 'bloglo_article_feed_layout', $layout );
}
/**
* Get ordered array of single post page sections.
*
* @since 1.0.0
* @param int $post_id Optional. The post ID to check. If not supplied, defaults to the current post if used in the loop.
* @return array, Section IDs for the single post layout.
*/
function bloglo_get_single_post_elements( $post_id = null ) {
if ( ! $post_id ) {
$post_id = get_the_ID();
}
$post_format = get_post_format( $post_id );
$options = bloglo_get_page_elements( 'single_post_elements' );
$elements = array();
if ( 'quote' !== $post_format ) {
$layout = bloglo_option( 'single_title_position' );
$layout = apply_filters( 'bloglo_single_title_position', $layout );
if ( 'in-content' === $layout ) {
if ( in_array( 'category', $options, true ) ) {
$elements[] = 'category';
}
$elements[] = 'header';
$elements[] = 'meta';
if ( bloglo_show_post_thumbnail( $post_id ) && in_array( 'thumb', $options, true ) ) {
$elements[] = 'thumbnail';
}
}
$elements[] = 'content';
$elements[] = 'content-footer';
}
if ( in_array( 'about-author', $options, true ) ) {
$elements[] = 'about-author';
}
if ( in_array( 'prev-next-post', $options, true ) ) {
$elements[] = 'prev-next-post';
}
$elements = apply_filters( 'bloglo_single_content_elements', $elements );
return $elements;
}
/**
* Check if single post element is displayed.
*
* @since 1.0.0
* @param string $element Element name.
* @return boolean Element is enabled or not.
*/
function bloglo_single_post_displays( $element ) {
$options = bloglo_get_page_elements( 'single_post_elements' );
return in_array( $element, $options, true );
}
/**
* Get ordered array of blog entry elements.
*
* @since 1.0.0
* @return array, Element IDs for the blog entry.
*/
function bloglo_get_blog_entry_elements() {
$elements = bloglo_get_page_elements( 'blog_entry_elements' );
return apply_filters( 'bloglo_blog_entry_elements', $elements );
}
/**
* Get ordered array of page elements.
*
* @since 1.0.0
* @param string $id Customizer setting ID.
* @param boolean $enabled_only Return only enabled/visible elements.
* @return array $elements Array of element IDs for the blog entry.
*/
function bloglo_get_page_elements( $id, $enabled_only = true ) {
$elements = bloglo_option( $id );
if ( empty( $elements ) ) {
return array();
}
if ( $enabled_only ) {
return array_keys( $elements, true, true );
}
return array_keys( $elements );
}
/**
* Get ordered array of meta elements.
*
* @since 1.0.0
* @param boolean $enabled_only Return only enabled/visible elements.
* @return array $elements Element IDs for the blog entry.
*/
function bloglo_get_entry_meta_elements( $enabled_only = true ) {
$elements = array();
if ( is_single() ) {
$elements = bloglo_option( 'single_post_meta_elements' );
} else {
$elements = bloglo_option( 'blog_entry_meta_elements' );
}
if ( $enabled_only ) {
$elements = array_keys( $elements, true, true );
} else {
$elements = array_keys( $elements );
}
return apply_filters( 'bloglo_entry_meta_elements', $elements );
}
/**
* Check if at least one entry meta element is enabled.
*
* @since 1.0.0
* @return boolean Has elements or not.
*/
function bloglo_has_entry_meta_elements() {
$elements = bloglo_get_entry_meta_elements();
return ! empty( $elements );
}
/**
* Wrap comment submit button with span tag.
*
* @since 1.0.0
* @param string $submit_button Comment content.
* @param array $args Button arguments.
*/
function bloglo_filter_comment_form_submit_button( $submit_button, $args ) {
return '<span class="bloglo-submit-form-button">' . $submit_button . '</span>'; // phpcs:ignore
}
add_filter( 'comment_form_submit_button', 'bloglo_filter_comment_form_submit_button', 10, 2 );
/**
* Filter excerpt length.
*
* @since 1.0.0
* @param int $length Word count for excerpt.
* @return int
*/
function bloglo_excerpt_length( $length ) {
if ( is_admin() ) {
return $length;
}
return intval( bloglo_option( 'excerpt_length' ) );
}
add_filter( 'excerpt_length', 'bloglo_excerpt_length' );
/**
* Filter excerpt more.
*
* @since 1.0.0
* @param string $more More indicator excerpt.
* @return string
*/
function bloglo_excerpt_more( $more ) {
if ( is_admin() ) {
return $more;
}
return bloglo_option( 'excerpt_more' );
}
add_filter( 'excerpt_more', 'bloglo_excerpt_more' );
/**
* Determines if post thumbnail can be displayed.
*
* @since 1.0.0
* @param int $post_id Optional. The post ID to check. If not supplied, defaults to the current post if used in the loop.
* @return boolean, Thumbnail displayed.
*/
function bloglo_show_post_thumbnail( $post_id = null ) {
$post_id = is_null( $post_id ) ? bloglo_get_the_id() : $post_id;
$display = ! post_password_required( $post_id ) && ! is_attachment( $post_id ) && has_post_thumbnail( $post_id );
if ( get_post_meta( $post_id, 'bloglo_disable_thumbnail', true ) ) {
$display = false;
}
return apply_filters( 'bloglo_show_post_thumbnail', $display );
}
if ( ! function_exists( 'bloglo_get_video_from_post' ) ) :
/**
* Get video HTML markup from post content.
*
* @since 1.0.0
* @param number $post_id Post id.
* @return mixed
*/
function bloglo_get_video_from_post( $post_id = null ) {
$post = get_post( $post_id );
$content = do_shortcode( apply_filters( 'the_content', $post->post_content ) ); // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound
$embeds = apply_filters( 'bloglo_get_post_video', get_media_embedded_in_content( $content ) );
if ( empty( $embeds ) ) {
return '';
}
// Return first embedded item that is a video format.
foreach ( $embeds as $embed ) {
if ( strpos( $embed, 'video' ) || strpos( $embed, 'youtube' ) || strpos( $embed, 'vimeo' ) ) {
return $embed;
}
}
}
endif;
if ( ! function_exists( 'bloglo_get_audio_from_post' ) ) :
/**
* Get video HTML markup from post content.
*
* @since 1.0.0
* @param number $post_id Post id.
* @return mixed
*/
function bloglo_get_audio_from_post( $post_id = null ) {
$post = get_post( $post_id );
$content = do_shortcode( apply_filters( 'the_content', $post->post_content ) ); // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound
$embeds = apply_filters( 'bloglo_get_post_audio', get_media_embedded_in_content( $content ) );
if ( empty( $embeds ) ) {
return '';
}
// check what is the first embed containg video tag, youtube or vimeo.
foreach ( $embeds as $embed ) {
if ( strpos( $embed, 'audio' ) || strpos( $embed, 'soundcloud' ) ) {
return '<span class="bloglo-post-audio-wrapper">' . $embed . '</span>';
}
}
}
endif;
if ( ! function_exists( 'bloglo_get_post_gallery' ) ) :
/**
* A get_post_gallery() polyfill for Gutenberg.
*
* @since 1.0.0
* @param object|int|null $post Optional. The post to check. If not supplied, defaults to the current post if used in the loop.
* @param boolean $html Return gallery HTML or array of gallery items.
* @return string|array The gallery html or array of gallery items.
*/
function bloglo_get_post_gallery( $post = 0, $html = false ) {
// Get gallery shortcode.
$gallery = get_post_gallery( $post, $html );
// Already found a gallery so lets quit.
if ( $gallery ) {
return $gallery;
}
// Check the post exists.
$post = get_post( $post );
if ( ! $post ) {
return;
}
// Not using Gutenberg so let's quit.
if ( ! function_exists( 'has_blocks' ) ) {
return;
}
// Not using blocks so let's quit.
if ( ! has_blocks( $post->post_content ) ) {
return;
}
/**
* Search for gallery blocks and then, if found, return the
* first gallery block.
*/
$pattern = '/<!--\ wp:gallery.*-->([\s\S]*?)<!--\ \/wp:gallery -->/i';
preg_match_all( $pattern, $post->post_content, $the_galleries );
// Check a gallery was found and if so change the gallery html.
if ( ! empty( $the_galleries[1] ) ) {
$gallery_html = reset( $the_galleries[1] );
if ( $html ) {
$gallery = $gallery_html;
} else {
$srcs = array();
$ids = array();
preg_match_all( '#src=([\'"])(.+?)\1#is', $gallery_html, $src, PREG_SET_ORDER );
if ( ! empty( $src ) ) {
foreach ( $src as $s ) {
$srcs[] = $s[2];
}
}
preg_match_all( '#data-id=([\'"])(.+?)\1#is', $gallery_html, $id, PREG_SET_ORDER );
if ( ! empty( $id ) ) {
foreach ( $id as $i ) {
$ids[] = $i[2];
}
}
$gallery = array(
'ids' => implode( ',', $ids ),
'src' => $srcs,
);
}
}
return $gallery;
}
endif;
if ( ! function_exists( 'bloglo_get_image_from_post' ) ) :
/**
* Get image HTML markup from post content.
*
* @since 1.0.0
* @param object|int|null $post Optional. The post to check. If not supplied, defaults to the current post if used in the loop.
* @param boolean $html Return image HTML or array of image items.
* @return mixed
*/
function bloglo_get_image_from_post( $post = null, $html = true ) {
// Check the post exists.
$post = get_post( $post );
if ( ! $post ) {
return;
}
$attachment_id = null;
// Using Blocks, check if wp:image exists.
if ( function_exists( 'has_blocks' ) && has_blocks( $post->post_content ) ) {
/**
* Search for image blocks.
*/
$pattern = '/<!--\ wp:image.*"id"\s*:\s*([0-9]+).*-->/i';
preg_match( $pattern, $post->post_content, $the_images );
// Check if an image was found.
if ( ! empty( $the_images[1] ) ) {
$attachment_id = absint( $the_images[1] );
}
}
// Nothing found, check if images added through Add Media.
if ( ! $attachment_id ) {
/**
* Search for img tags in the content.
*/
$pattern = '/<img.*wp-image-([0-9]+).*>/';
preg_match( $pattern, $post->post_content, $the_images );
// Check if an image was found.
if ( ! empty( $the_images[0] ) ) {
$attachment_id = absint( $the_images[0] );
}
}
// Still nothing was found, check for attached images.
if ( ! $attachment_id ) {
$the_images = get_attached_media( 'image', $post->ID );
if ( ! empty( $the_images ) ) {
$image = reset( $the_images );
$attachment_id = $image->ID;
}
}
// Check if an image was found.
if ( $attachment_id ) {
if ( $html ) {
$atts = array(
'alt' => get_the_title( $post->ID ),
);
if ( bloglo_get_schema_markup( 'image' ) ) {
$atts['itemprop'] = 'image';
}
return wp_get_attachment_image( $attachment_id, 'full', false, $atts );
} else {
return wp_get_attachment_url( $attachment_id );
}
}
return false;
}
endif;
if ( ! function_exists( 'bloglo_get_post_thumbnail' ) ) :
/**
* Get post thumbnail markup.
*
* @since 1.0.0
* @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
* @param string|array $size Optional. Image size to use. Accepts any valid image size, or
* an array of width and height values in pixels (in that order).
* Default 'post-thumbnail'.
* @param boolean $caption Optional. Display image caption.
* @return string The post thumbnail image tag.
*/
function bloglo_get_post_thumbnail( $post = null, $size = 'post-thumbnail', $caption = false ) {
$attachment_id = get_post_thumbnail_id( $post );
$attachment_alt = trim(strip_tags(get_post_meta($attachment_id, '_wp_attachment_image_alt', true))); // phpcs:ignore
$attachment_alt = empty( $attachment_alt ) ? get_the_title( $post ) : $attachment_alt;
$atts = array(
'alt' => $attachment_alt,
);
if ( bloglo_get_schema_markup( 'image' ) ) {
$atts['itemprop'] = 'image';
}
$size = apply_filters( 'bloglo_post_thumbnail_default_size', $size );
$atts = apply_filters( 'bloglo_post_thumbnail_default_size', $atts );
$html = get_the_post_thumbnail( $post, $size, $atts );
if ( $caption ) {
$caption = wp_get_attachment_caption( $attachment_id );
if ( ! empty( $caption ) ) {
$caption = '<div class="post-thumb-caption">' . wp_kses( $caption, bloglo_get_allowed_html_tags( 'button' ) ) . '</div>';
}
$html .= $caption;
}
return apply_filters( 'bloglo_post_thumbnail_html', $html, $post, $attachment_id, $size, $atts );
}
endif;
if ( ! function_exists( 'bloglo_entry_get_permalink' ) ) :
/**
* Get permalink for one post entry.
*
* @since 1.0.0
* @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
* @return string
*/
function bloglo_entry_get_permalink( $post = null ) {
$permalink = '';
if ( 'link' === get_post_format( $post ) ) {
$permalink = get_url_in_content( get_the_content( $post ) );
} else {
$permalink = get_permalink( $post );
}
return apply_filters( 'bloglo_entry_permalink', $permalink );
}
endif;
/**
* Determines breadcrumbs are displayed.
*
* @since 1.0.0
*
* @param int $post_id Optional. The post ID to check.
* @return boolean, Breadcrumbs displayed.
*/
function bloglo_has_breadcrumbs( $post_id = 0 ) {
if ( ! $post_id ) {
$post_id = bloglo_get_the_id();
}
$display = bloglo_option( 'breadcrumbs_enable' );
if ( $display && bloglo_is_section_disabled( bloglo_option( 'breadcrumbs_hide_on' ), $post_id ) ) {
$display = false;
}
if ( $display && $post_id && get_post_meta( $post_id, 'bloglo_disable_breadcrumbs', true ) ) {
$display = false;
}
return apply_filters( 'bloglo_has_breadcrumbs', $display, $post_id );
}
/**
* Determines if page header breadcrumbs are displayed.
*
* @since 1.0.0
*
* @param int $post_id Optional. The post ID to check.
* @return boolean, Breadcrumbs displayed.
*/
function bloglo_page_header_has_breadcrumbs( $post_id = 0 ) {
return bloglo_has_breadcrumbs( $post_id ) && 'in-page-header' === bloglo_option( 'breadcrumbs_position' );
}
/**
* Determines if page header title & description are displayed.
*
* @since 1.0.0
*
* @param int $post_id Optional. The post ID to check.
* @return boolean, Title & description displayed.
*/
function bloglo_page_header_has_title( $post_id = 0 ) {
if ( ! $post_id ) {
$post_id = bloglo_get_the_id();
}
$display = true;
if ( is_singular( 'post' ) && ! in_array( bloglo_option( 'single_title_position' ), array( 'in-page-header' ), true ) ) {
$display = false;
}
// Disabled in post meta settings.
if ( get_post_meta( $post_id, 'bloglo_disable_page_title', true ) ) {
$display = false;
}
// Finally, check if title string is empty.
if ( $display ) {
$title = apply_filters( 'bloglo_page_header_title', bloglo_get_the_title() );
if ( ! $title ) {
$display = false;
}
}
return apply_filters( 'bloglo_page_header_has_title', $display );
}
/**
* Determines if comments are displayed.
*
* @since 1.0.0
* @return boolean, true if comments are displayed.
*/
function bloglo_comments_displayed() {
$display = true;
/*
* Return false if comments are closed and there are no comments already posted.
*/
if ( ! is_singular() || ( ! comments_open() && ! get_comments_number() ) || ! post_type_supports( get_post_type(), 'comments' ) ) {
$display = false;
}
/*
* If the current post is protected by a password and
* the visitor has not yet entered the password we will
* return early without loading the comments.
*/
if ( post_password_required() ) {
return false;
}
return apply_filters( 'bloglo_display_comments', $display );
}
/**
* Determines if comments toggle is displayed.
*
* @since 1.0.0
* @return boolean, true if comments toggle is displayed.
*/
function bloglo_comments_toggle_displayed() {
$return = bloglo_option( 'single_toggle_comments' );
return apply_filters( 'bloglo_display_comments_toggle', $return );
}
/**
* Add attributes to Masthead.
*
* @since 1.0.0
* @param array $atts Attributes array.
* @param int $post_id Optional. The post ID to check. If not supplied, defaults to the current post if used in the loop.
* @return void|string
*/
function bloglo_masthead_atts( $atts = array(), $post_id = '' ) {
if ( is_singular( 'post' ) && 'in-page-header' === bloglo_option( 'single_title_position' ) && bloglo_is_header_transparent( $post_id ) ) {
if ( bloglo_show_post_thumbnail( $post_id ) && bloglo_single_post_displays( 'thumb' ) ) {
$atts['style'] = isset( $atts['style'] ) ? $atts['style'] : '';
$atts['style'] .= 'background-image: url(' . wp_get_attachment_image_url( get_post_thumbnail_id( $post_id ), 'full' ) . ');';
}
}
$atts = apply_filters( 'bloglo_masthead_atts', $atts, $post_id );
if ( ! empty( $atts ) ) {
$output = '';
foreach ( $atts as $att => $content ) {
$output .= sanitize_title( $att ) . '="' . esc_attr( $content ) . '"';
}
$output = empty( $output ) ? '' : ' ' . $output;
echo $output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
}
/**
* Add classes to Front Section.
*
* @since 1.0.0
* @param array $classes Classes array.
* @return void
*/
function bloglo_section_classes( $section ) {
$classes = array();
// Optional wide header container.
if ( 'full-width' === bloglo_option( $section . '_container_width' ) ) {
$classes[] = 'bloglo-container__wide';
}
$classes = apply_filters( 'bloglo_section_classes', $classes );
if ( ! empty( $classes ) ) {
$classes = trim( implode( ' ', $classes ) );
echo esc_attr( $classes );
}
}
/**
* Add classes to Header.
*
* @since 1.0.0
* @param array $classes Classes array.
* @return void
*/
function bloglo_header_classes( $classes = array() ) {
// Optional wide header container.
if ( 'full-width' === bloglo_option( 'header_container_width' ) ) {
$classes[] = 'bloglo-container__wide';
}
$classes = apply_filters( 'bloglo_header_classes', $classes );
if ( ! empty( $classes ) ) {
$classes = trim( implode( ' ', $classes ) );
echo 'class="' . esc_attr( $classes ) . '"';
}
}
/**
* Add classes to Top Bar.
*
* @since 1.0.0
* @param array $classes Classes array.
* @return void
*/
function bloglo_top_bar_classes( $classes = array() ) {
// Optional wide top bar container.
if ( 'full-width' === bloglo_option( 'top_bar_container_width' ) ) {
$classes[] = 'bloglo-container__wide';
}
// Top Bar visibility.
$top_bar_visibility = bloglo_option( 'top_bar_visibility' );
if ( 'all' !== $top_bar_visibility ) {
$classes[] = 'bloglo-' . $top_bar_visibility;
}
$classes = apply_filters( 'bloglo_top_bar_classes', $classes );
if ( ! empty( $classes ) ) {
$classes = trim( implode( ' ', $classes ) );
echo 'class="' . esc_attr( $classes ) . '"';
}
}
/**
* Add classes to Page Header.
*
* @since 1.0.0
* @param array $classes Classes array.
* @return void
*/
function bloglo_page_header_classes( $classes = array() ) {
$classes[] = 'page-header';
// Background image.
if ( is_singular( 'post' ) && 'in-page-header' === bloglo_option( 'single_title_position' ) ) {
$classes[] = 'bloglo-page-title-has-bg-img';
}
if ( bloglo_page_header_has_title() ) {
$classes[] = 'bloglo-has-page-title';
}
if ( bloglo_page_header_has_breadcrumbs() ) {
$classes[] = 'bloglo-has-breadcrumbs';
}
$classes = apply_filters( 'bloglo_page_header_classes', $classes );
if ( ! empty( $classes ) ) {
$classes = trim( implode( ' ', $classes ) );
echo 'class="' . esc_attr( $classes ) . '"';
}
}
/**
* Add attributes to Page Header.
*
* @since 1.0.0
* @param array $atts Array of additional attributes.
* @param int $post_id Optional. The post ID to check. If not supplied, defaults to the current post if used in the loop.
* @return void
*/
function bloglo_page_header_atts( $atts = array(), $post_id = '' ) {
if ( is_singular( 'post' ) && 'in-page-header' === bloglo_option( 'single_title_position' ) && ! bloglo_is_header_transparent( $post_id ) ) {
if ( bloglo_show_post_thumbnail( $post_id ) && bloglo_single_post_displays( 'thumb' ) ) {
$atts['style'] = isset( $atts['style'] ) ? $atts['style'] : '';
$atts['style'] .= 'background-image: url(' . wp_get_attachment_image_url( get_post_thumbnail_id( $post_id ), 'full' ) . ');';
}
}
$atts = apply_filters( 'bloglo_page_header_atts', $atts, $post_id );
if ( ! empty( $atts ) ) {
$output = '';
foreach ( $atts as $att => $content ) {
$output .= sanitize_title( $att ) . '="' . esc_attr( $content ) . '"';
}
$output = empty( $output ) ? '' : ' ' . $output;
echo $output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
}
/**
* Add classes to Hero.
*
* @since 1.0.0
* @param array $classes Classes array.
* @return void
*/
function bloglo_hero_classes( $classes = array() ) {
// Hero visibility.
$visibility = bloglo_option( 'hero_visibility' );
if ( 'all' !== $visibility ) {
$classes[] = 'bloglo-' . $visibility;
}
$classes = apply_filters( 'bloglo_hero_classes', $classes );
if ( ! empty( $classes ) ) {
$classes = trim( implode( ' ', $classes ) );
echo 'class="' . esc_attr( $classes ) . '"';
}
}
/**
* Add classes to Featured links.
*
* @since 1.0.0
* @param array $classes Classes array.
* @return void
*/
function bloglo_featured_links_classes( $classes = array() ) {
// Hero visibility.
$visibility = bloglo_option( 'featured_links_visibility' );
if ( 'all' !== $visibility ) {
$classes[] = 'bloglo-' . $visibility;
}
$classes = apply_filters( 'bloglo_featured_links_classes', $classes );
if ( ! empty( $classes ) ) {
$classes = trim( implode( ' ', $classes ) );
echo 'class="' . esc_attr( $classes ) . '"';
}
}
/**
* Add classes to PYML.
*
* @since 1.0.0
* @param array $classes Classes array.
* @return void
*/
function bloglo_pyml_classes( $classes = array() ) {
// PYML visibility.
$visibility = bloglo_option( 'pyml_visibility' );
if ( 'all' !== $visibility ) {
$classes[] = 'bloglo-' . $visibility;
}
$classes = apply_filters( 'bloglo_pyml_classes', $classes );
if ( ! empty( $classes ) ) {
$classes = trim( implode( ' ', $classes ) );
echo 'class="' . esc_attr( $classes ) . '"';
}
}
/**
* Add classes to Ticker News.
*
* @since 1.0.0
* @param array $classes Classes array.
* @return void
*/
function bloglo_ticker_classes( $classes = array() ) {
// Ticker News visibility.
$visibility = bloglo_option( 'ticker_visibility' );
if ( 'all' !== $visibility ) {
$classes[] = 'bloglo-' . $visibility;
}
$classes = apply_filters( 'bloglo_ticker_classes', $classes );
if ( ! empty( $classes ) ) {
$classes = trim( implode( ' ', $classes ) );
echo 'class="' . esc_attr( $classes ) . '"';
}
}
/**
* Add classes to Scroll Top Button.
*
* @since 1.0.0
* @param array $classes Classes array.
* @return void
*/
function bloglo_scroll_top_classes( $classes = array() ) {
// Scroll Top visibility.
$scroll_top_visibility = bloglo_option( 'scroll_top_visibility' );
if ( 'all' !== $scroll_top_visibility ) {
$classes[] = 'bloglo-' . $scroll_top_visibility;
}
$classes = apply_filters( 'bloglo_scroll_top_classes', $classes );
if ( ! empty( $classes ) ) {
$classes = trim( implode( ' ', $classes ) );
echo 'class="' . esc_attr( $classes ) . '"';
}
}
/**
* Add classes to Page Preloader.
*
* @since 1.0.0
* @return void
*/
function bloglo_preloader_classes() {
$classes = array();
// Page Preloader visibility.
$preloader_visibility = bloglo_option( 'preloader_visibility' );
if ( 'all' !== $preloader_visibility ) {
$classes[] = 'bloglo-' . $preloader_visibility;
}
$classes = apply_filters( 'bloglo_preloader_classes', $classes );
if ( ! empty( $classes ) ) {
$classes = trim( implode( ' ', $classes ) );
echo ' class="' . esc_attr( $classes ) . '"';
}
}
/**
* Add classes to Main Footer.
*
* @since 1.0.0
* @param array $classes Classes array.
* @return void
*/
function bloglo_footer_classes( $classes = array() ) {
// Main Footer visibility.
$footer_visibility = bloglo_option( 'footer_visibility' );
if ( 'all' !== $footer_visibility ) {
$classes[] = 'bloglo-' . $footer_visibility;
}
$classes = apply_filters( 'bloglo_footer_classes', $classes );
if ( ! empty( $classes ) ) {
$classes = trim( implode( ' ', $classes ) );
echo 'class="' . esc_attr( $classes ) . '"';
}
}
/**
* Get footer widgets column count.
*
* @since 1.0.0
* @return integer Number of footer columns
*/
function bloglo_get_footer_column_count() {
$count = 4;
return apply_filters( 'bloglo_footer_column_count', $count );
}
/**
* Get footer widgets column count.
*
* @since 1.0.0
* @param string $layout Footer layout.
* @return array Classes array
*/
function bloglo_get_footer_column_class( $layout = 'layout-1' ) {
$classes = array(
'layout-1' => array(
'col-xs-12 col-sm-6 stretch-xs col-md-3',
'col-xs-12 col-sm-6 stretch-xs col-md-3',
'col-xs-12 col-sm-6 stretch-xs col-md-3',
'col-xs-12 col-sm-6 stretch-xs col-md-3',
),
'layout-2' => array(
'col-xs-12 col-sm-6 stretch-xs col-md-4',
'col-xs-12 col-sm-6 stretch-xs col-md-4',
'col-xs-12 col-sm-6 stretch-xs col-md-4',
),
'layout-3' => array(
'col-xs-12 col-sm-6 stretch-xs col-md-8',
'col-xs-12 col-sm-6 stretch-xs col-md-4',
),
'layout-4' => array(
'col-xs-12 col-sm-6 stretch-xs col-md-4',
'col-xs-12 col-sm-6 stretch-xs col-md-8',
),
'layout-5' => array(
'col-xs-12 col-sm-6 stretch-xs col-md-6',
'col-xs-12 col-sm-6 stretch-xs col-md-3',
'col-xs-12 col-sm-6 stretch-xs col-md-3',
),
'layout-6' => array(
'col-xs-12 col-sm-6 stretch-xs col-md-3',
'col-xs-12 col-sm-6 stretch-xs col-md-3',
'col-xs-12 col-sm-6 stretch-xs col-md-6',
),
'layout-7' => array(
'col-xs-12 col-sm-6 stretch-xs col-md-6',
'col-xs-12 col-sm-6 stretch-xs col-md-6',
),
'layout-8' => array(
'col-xs-12 col-sm-12 stretch-xs col-md-12',
),
);
$classes = apply_filters( 'bloglo_footer_column_classes', $classes, $layout );
$classes = isset( $classes[ $layout ] ) ? $classes[ $layout ] : array();
$align_center = bloglo_option( 'footer_widgets_align_center' );
if ( $align_center && ! empty( $classes ) ) {
foreach ( $classes as $key => $column_class ) {
$classes[ $key ] = $column_class . ' center-text';
}
}
return $classes;
}
/**
* Add classes to Copyright bar.
*
* @since 1.0.0
* @param array $classes Classes array.
* @return void
*/
function bloglo_copyright_classes( $classes = array() ) {
// Copyright visibility.
$visibility = bloglo_option( 'copyright_visibility' );
if ( 'all' !== $visibility ) {
$classes[] = 'bloglo-' . $visibility;
}
// Copyright separator style.
$separator = bloglo_option( 'copyright_separator' );
if ( $separator && 'none' !== $separator ) {
$classes[] = $separator;
}
$classes = apply_filters( 'bloglo_copyright_classes', $classes );
if ( ! empty( $classes ) ) {
$classes = trim( implode( ' ', $classes ) );
echo 'class="' . esc_attr( $classes ) . '"';
}
}
/**
* Adds custom classes to the array of body classes.
*
* @since 1.0.0
* @param array $classes Classes for the body element.
* @return array
*/
function bloglo_body_classes( $classes ) {
// Topbar separator styles.
if ( bloglo_option( 'top_bar_widgets_separator' ) ) {
$classes[] = 'bloglo-topbar__separators-' . bloglo_option( 'top_bar_widgets_separator' );
}
// Mobile.
if ( wp_is_mobile() ) {
$classes[] = 'bloglo-is-mobile';
}
// Site layout.
$classes[] = 'bloglo-layout__' . bloglo_get_site_layout();
// Post card border.
if ( bloglo_is_blog_card_border_displayed() === true ) {
$classes[] = 'bloglo-layout__boxed-separated';
}
// Post card border.
if ( bloglo_option( 'blog_card_shadow' ) === true && bloglo_is_blog_card_border_displayed() === true ) {
$classes[] = 'bloglo-layout-shadow';
}
// Header related styles.
if ( bloglo_is_header_displayed() ) {
// Header layout.
$classes[] = 'bloglo-header-' . bloglo_option( 'header_layout' );
// Menu item hover animation.
$classes[] = 'bloglo-menu-animation-' . bloglo_option( 'main_nav_hover_animation' );
// Header widgets separator.
$classes[] = 'bloglo-header__separators-' . bloglo_option( 'header_widgets_separator' );
}
// Transparent header.
if ( bloglo_is_header_transparent() && ( bloglo_is_header_displayed() || bloglo_is_top_bar_displayed() ) ) {
$classes[] = 'bloglo-tsp-header';
if ( ! bloglo_is_page_header_displayed() ) {
$classes[] = 'bloglo-tsp-absolute';
}
}
// Blog style.
if ( is_page_template( 'page-templates/template-blog-masonry.php' ) || is_front_page() || is_home() || is_archive() || is_search() ) {
$bloglo_article_feed_layout = bloglo_get_article_feed_layout();
if ( '' !== $bloglo_article_feed_layout ) {
$classes[] = 'bloglo-' . bloglo_get_article_feed_layout();
}
}
// Single post.
if ( is_singular( 'post' ) ) {
$title_position = bloglo_option( 'single_title_position' );
$classes[] = 'bloglo-single-title-' . $title_position;
// Narrow content for single post.
if ( 'narrow' === bloglo_option( 'single_content_width' ) ) {
$classes[] = 'narrow-content';
}
}
$title_alignment = is_single() ? bloglo_option( 'single_title_alignment' ) : bloglo_option( 'page_header_alignment' );
$classes[] = 'bloglo-page-title-align-' . $title_alignment;
// Has comments.
if ( is_singular() && comments_open() ) {
$classes[] = 'comments-open';
}
// RTL.
if ( is_rtl() ) {
$classes[] = 'bloglo-is-rtl';
}
// Sidebar.
if ( bloglo_is_sidebar_displayed() ) {
$classes[] = 'bloglo-has-sidebar';
// Sticky sidebar.
$sidebar_sticky = bloglo_option( 'sidebar_sticky' );
if ( $sidebar_sticky ) {
$classes[] = 'bloglo-sticky-' . $sidebar_sticky;
}
// Sidebar style.
$classes[] = 'bloglo-sidebar-style-' . bloglo_option( 'sidebar_style' );
// Sidebar position.
$classes[] = 'bloglo-sidebar-position__' . bloglo_get_sidebar_position();
$classes[] = 'bloglo-sidebar-r__' . bloglo_option( 'sidebar_responsive_position' );
} else {
// No sidebar.
$classes[] = 'bloglo-no-sidebar';
}
// Entry media hover style.
$classes[] = 'entry-media-hover-style-1';
// Show/Hide Comments button.
if ( bloglo_comments_displayed() && bloglo_comments_toggle_displayed() ) {
$classes[] = 'bloglo-has-comments-toggle';
}
// Copyright layout.
if ( bloglo_is_copyright_bar_displayed() ) {
$classes[] = 'bloglo-copyright-' . bloglo_option( 'copyright_layout' );
}
// Section Heading Style.
$headingStyle = absint( bloglo_option( 'section_heading_style' ) );
$classes[] = 'is-section-heading-init-s' . $headingStyle;
// Initialize Parallax Footer.
$headingStyle = absint( bloglo_option( 'parallax_footer' ) );
if ( true == $headingStyle ) {
$classes[] = 'is-parallax-footer';
}
// Pre Footer.
if ( bloglo_is_pre_footer_displayed() ) {
// Call to Action classes.
if ( bloglo_is_pre_footer_cta_displayed() ) {
$style = absint( bloglo_option( 'pre_footer_cta_style' ) );
if ( 1 === $style && ! bloglo_is_footer_displayed() && ! bloglo_is_copyright_bar_displayed() ) {
$classes[] = 'bloglo-pre-footer-no-margin';
}
$classes[] = 'bloglo-pre-footer-cta-style-' . $style;
}
}
// Footer Widget Heading Style.
$footerWidgetHeadingStyle = absint( bloglo_option( 'footer_widget_heading_style' ) );
$classes[] = 'is-footer-heading-init-s' . $footerWidgetHeadingStyle;
// Custom input fields design.
if ( bloglo_option( 'custom_input_style' ) ) {
$classes[] = 'bloglo-input-supported';
}
// Validate comment form.
$classes[] = 'validate-comment-form';
// Menu accessibility support.
$classes[] = 'bloglo-menu-accessibility';
return $classes;
}
add_filter( 'body_class', 'bloglo_body_classes' );
/**
* Modifies the default Read More link. Do not show if "Read More" button (from Customizer) is enabled.
*
* @since 1.0.0
* @return Modified read more HTML.
*/
function bloglo_modify_read_more_link() {
$has_read_more = in_array( 'summary-footer', bloglo_get_blog_entry_elements(), true );
$class = $has_read_more ? ' bloglo-hide' : '';
return '<footer class="entry-footer' . esc_attr( $class ) . '"><a class="bloglo-btn btn-text-1" href="' . esc_url( get_the_permalink() ) . '" role="button"><span>' . esc_html__( 'Continue Reading', 'bloglo' ) . '</span></a></footer>';
}
add_filter( 'the_content_more_link', 'bloglo_modify_read_more_link' );
/**
* Insert dynamic text into content.
*
* @since 1.0.0
* @param string $content Text to be modified.
* @return string Modified text.
*/
function bloglo_dynamic_strings( $content ) {
$content = str_replace( '{{the_year}}', date_i18n( 'Y' ), $content );
$content = str_replace( '{{the_date}}', date_i18n( get_option( 'date_format' ) ), $content );
$content = str_replace( '{{site_title}}', get_bloginfo( 'name' ), $content );
$content = str_replace( '{{theme_link}}', '<a href="https://wordpress.org/themes/bloglo/" class="imprint" target="_blank" rel="noopener noreferrer">Bloglo WordPress Theme</a>', $content );
if ( false !== strpos( $content, '{{current_user}}' ) ) {
$current_user = wp_get_current_user();
$content = str_replace( '{{current_user}}', apply_filters( 'bloglo_logged_out_user_name', $current_user->display_name ), $content );
}
return apply_filters( 'bloglo_parse_dynamic_strings', $content );
}
add_filter( 'bloglo_dynamic_strings', 'bloglo_dynamic_strings' );
/**
* Add headers for IE to override IE's Compatibility View Settings
*
* @since 1.0.0
* @param array $headers The list of headers to be sent.
*/
function bloglo_x_ua_compatible_headers( $headers ) {
$headers['X-UA-Compatible'] = 'IE=edge';
return $headers;
}
add_filter( 'wp_headers', 'bloglo_x_ua_compatible_headers' );
/**
* Removes parentheses from widget category count.
*
* @since 1.0.0
* @param array $variable The filtered variable.
*/
function bloglo_cat_count_filter( $variable ) {
$variable = str_replace( '(', '<span> ', $variable );
$variable = str_replace( ')', ' </span>', $variable );
return $variable;
}
add_filter( 'wp_list_categories', 'bloglo_cat_count_filter' );
/**
* Removes parentheses from widget archive count.
*
* @since 1.0.0
* @param array $variable The filtered variable.
*/
function bloglo_arc_count_filter( $variable ) {
$variable = str_replace( '(', '<span>', $variable );
$variable = str_replace( ')', '</span>', $variable );
return $variable;
}
add_filter( 'get_archives_link', 'bloglo_arc_count_filter' );
/**
* Add descriptions on menu dropdowns.
*
* @since 1.0.0
* @param string $item_output HTML output for the menu item.
* @param object $item menu item object.
* @param int $depth depth in menu structure.
* @param object $args arguments passed to wp_nav_menu().
* @return string $item_output
*/
function bloglo_header_menu_desc( $item_output, $item, $depth, $args ) {
if ( $item->description ) {
$item_output = str_replace( '</span>', '<span class="description">' . $item->description . '</span></span>', $item_output );
}
return $item_output;
}
add_filter( 'walker_nav_menu_start_el', 'bloglo_header_menu_desc', 10, 4 );