sewmyheadon / spurs

inc/extras.php

<?php
/**
 * Custom functions that act independently of the theme templates.
 *
 * Eventually, some of the functionality here could be replaced by core features.
 *
 * @package spurs
 */

// Exit if accessed directly.
defined( 'ABSPATH' ) || exit;

add_filter( 'body_class', 'spurs_body_classes' );

if ( ! function_exists( 'spurs_body_classes' ) ) {
	/**
	 * Adds custom classes to the array of body classes.
	 *
	 * @param array $classes Classes for the body element.
	 *
	 * @return array
	 */
	function spurs_body_classes( $classes ) {
		// Adds a class of group-blog to blogs with more than 1 published author.
		if ( is_multi_author() ) {
			$classes[] = 'group-blog';
		}
		// Adds a class of hfeed to non-singular pages.
		if ( ! is_singular() ) {
			$classes[] = 'hfeed';
		}

		return $classes;
	}
}

// Removes tag class from the body_class array to avoid Bootstrap markup styling issues.
add_filter( 'body_class', 'spurs_adjust_body_class' );

if ( ! function_exists( 'spurs_adjust_body_class' ) ) {
	/**
	 * Setup body classes.
	 *
	 * @param string $classes CSS classes.
	 *
	 * @return mixed

Consider making the return type a bit more specific; maybe use string.

	 */
	function spurs_adjust_body_class( $classes ) {

		foreach ( $classes as $key => $value ) {

The expression $classes of type string is not traversable.

			if ( 'tag' == $value ) {
				unset( $classes[ $key ] );
			}
		}

		return $classes;
	}
}

// Filter custom logo with correct classes.
add_filter( 'get_custom_logo', 'spurs_change_logo_class' );

if ( ! function_exists( 'spurs_change_logo_class' ) ) {
	/**
	 * Replaces logo CSS class.
	 *
	 * @param string $html Markup.
	 *
	 * @return mixed

Consider making the return type a bit more specific; maybe use string.

	 */
	function spurs_change_logo_class( $html ) {

		$html = str_replace( 'class="custom-logo"', 'class="img-fluid"', $html );

Consider using a different name than the parameter $html. This often makes code more readable.

		$html = str_replace( 'class="custom-logo-link"', 'class="navbar-brand custom-logo-link"', $html );

Consider using a different name than the parameter $html. This often makes code more readable.

		$html = str_replace( 'alt=""', 'title="Home" alt="logo"', $html );

Consider using a different name than the parameter $html. This often makes code more readable.

		return $html;
	}
}

if ( ! function_exists( 'spurs_post_nav' ) ) {
	/**
	 * Display navigation to next/previous post when applicable.
	 *
	 * @return void
	 * @since 1.0.0
	 *
	 */
	function spurs_post_nav() {
		// Don't print empty markup if there's nowhere to navigate.
		$previous = ( is_attachment() ) ? get_post( get_post()->post_parent ) : get_adjacent_post( false, '', true );
		$next     = get_adjacent_post( false, '', false );

		if ( ! $next && ! $previous ) {
			return;
		}
		?>
		<nav class="container navigation post-navigation">
			<h2 class="sr-only"><?php _e( 'Post navigation', 'spurs' ); ?></h2>
			<div class="row nav-links justify-content-between">
				<?php

				if ( get_previous_post_link() ) {
					previous_post_link( '<span class="nav-previous">%link</span>', _x( '<i class="fa fa-angle-left"></i>&nbsp;%title', 'Previous post link', 'spurs' ) );
				}
				if ( get_next_post_link() ) {
					next_post_link( '<span class="nav-next">%link</span>', _x( '%title&nbsp;<i class="fa fa-angle-right"></i>', 'Next post link', 'spurs' ) );
				}
				?>
			</div><!-- .nav-links -->
		</nav><!-- .navigation -->

		<?php
	}
}
if ( ! function_exists( 'spurs_pingback' ) ) {
	/**
	 * Add a pingback url auto-discovery header for single posts of any post type.
	 */
	function spurs_pingback() {
		if ( is_singular() && pings_open() ) {
			echo '<link rel="pingback" href="' . esc_url( get_bloginfo( 'pingback_url' ) ) . '">' . "\n";
		}
	}
}
add_action( 'wp_head', 'spurs_pingback' );

if ( ! function_exists( 'spurs_mobile_web_app_meta' ) ) {
	/**
	 * Add mobile-web-app meta.
	 */
	function spurs_mobile_web_app_meta() {
		echo '<meta name="mobile-web-app-capable" content="yes">' . "\n";
		echo '<meta name="apple-mobile-web-app-capable" content="yes">' . "\n";
		echo '<meta name="apple-mobile-web-app-title" content="' . esc_attr( get_bloginfo( 'name' ) ) . ' - ' . esc_attr( get_bloginfo( 'description' ) ) . '">' . "\n";
	}
}
add_action( 'wp_head', 'spurs_mobile_web_app_meta' );


/**
 * Search/replace string to make everything lower case and convert spaces and underscores to dashes.
 *
 * @param $string
 *
 * @return null|string|string[]
 */
function spurs_tidy_url( $string ) {
	// Convert everything to lower case
	$string = strtolower( $string );

Consider using a different name than the parameter $string. This often makes code more readable.

	// Make everything alphanumeric (removes all other characters)
	$string = preg_replace( "/[^a-z0-9_\s-]/", "", $string );

Consider using a different name than the parameter $string. This often makes code more readable.

	// Clean up multiple dashes or whitespace
	$string = preg_replace( "/[\s-]+/", " ", $string );

Consider using a different name than the parameter $string. This often makes code more readable.

	// Convert whitespace and underscore to dash
	$string = preg_replace( "/[\s_]/", "-", $string );

Consider using a different name than the parameter $string. This often makes code more readable.

	return $string;
}

/**
 * Set Google Maps API Key for Advanced Custom Fields
 */
add_action( 'acf/init', 'rcn_acf_init' );
function rcn_acf_init() {
	acf_update_setting( 'google_api_key', '' );
}

/**
 * Output background image style
 *
 * @param array|string $img Image array or url
 * @param string $size Image size to retrieve
 * @param bool $echo Whether to output the the style tag or return it.
 *
 * @return string|void String when retrieving.
 */
if ( ! function_exists( 'bg' ) ) {

	function bg($img, $size = '', $echo = true, $additional_style = '') {
		if ( ! $img ) {
		    $uploads = wp_get_upload_dir();
		    $url = $uploads['baseurl'] . '/path_to_fallback_image.png'; // default placeholder image
		} else {
            if ( is_array( $img ) ) {
                $url = $size ? $img['sizes'][ $size ] : $img['url'];
            } else {
                $url = $img;
            }
        }

		/*if (strpos($_SERVER['HTTP_ACCEPT'], 'image/webp') !== false) {

			$webp_suffix_url = $url . '.webp';
			$headers = @get_headers($webp_suffix_url);

			if (strpos($headers[0], '200') > -1) {
				$url = $webp_suffix_url;
			} else {
				$webp_url = preg_replace('/(?:jpg|png|gif)$/i', 'webp', $url);
				$headers = @get_headers($webp_url);

				if (strpos($headers[0], '200') > -1) {
					$url = $webp_url;
				}
			}
		}*/

		$string = 'style="background-image: url(' . $url . '); ' . $additional_style . '"';

		if ( $echo ) {
			echo $string;
		} else {
			return $string;
		}
	}
}

/**
 * Output HTML markup of template with passed args
 *
 * @param string $file File name without extension (.php)
 * @param array $args Array with args ($key=>$value)
 * @param string $default_folder Requested file folder
 *
 * */
if ( ! function_exists( 'show_template' ) ) {
	function show_template( $file, $args = null, $default_folder = 'parts' ) {
		echo return_template( $file, $args, $default_folder );
	}
}

/**
 * Return HTML markup of template with passed args
 *
 * @param string $file File name without extension (.php)
 * @param array $args Array with args ($key=>$value)
 * @param string $default_folder Requested file folder
 *
 * @return string template HTML
 * */
if ( ! function_exists( 'return_template' ) ) {
	function return_template( $file, $args = null, $default_folder = 'parts' ) {
		$file = $default_folder . '/' . $file . '.php';

Consider using a different name than the parameter $file. This often makes code more readable.

		if ( $args ) {
			extract( $args );
		}
		if ( locate_template( $file ) ) {
			ob_start();
			include( locate_template( $file ) ); //Theme Check free. Child themes support.
			$template_content = ob_get_clean();

			return $template_content;
		}

		return '';
	}
}

/**
 * Get the primary term of a post, by taxonomy.
 * If Yoast Primary Term is used, return it,
 * otherwise fallback to the first term.
 *
 * @param string $taxonomy The taxonomy to get the primary term from.
 * @param int $post_id The post ID to check.

Should the type for parameter $post_id not be false|integer?

 *
 * @return   WP_Term|bool  The term object or false if no terms.
 * @author   Mike Hemberger @JiveDig.
 *
 * @version  1.1.0
 *
 * @link     https://gist.github.com/JiveDig/5d1518f370b1605ae9c753f564b20b7f
 * @link     https://gist.github.com/jawinn/1b44bf4e62e114dc341cd7d7cd8dce4c
 */
function spurs_get_primary_term( $taxonomy = 'category', $post_id = false ) {

	// Bail if no taxonomy.
	if ( ! $taxonomy ) {
		return false;
	}

	// If no post ID, set it.
	if ( ! $post_id ) {

The expression $post_id of type false|integer is loosely compared to false; this is ambiguous if the integer can be zero. You might want to explicitly use === null instead.

		$post_id = get_the_ID();

Consider using a different name than the parameter $post_id. This often makes code more readable.

	}

	// If checking for WPSEO.
	if ( class_exists( 'WPSEO_Primary_Term' ) ) {

		// Get the primary term.
		$wpseo_primary_term = new WPSEO_Primary_Term( $taxonomy, $post_id );
		$wpseo_primary_term = $wpseo_primary_term->get_primary_term();

		// If we have one, return it.
		if ( $wpseo_primary_term ) {
			return get_term( $wpseo_primary_term );
		}
	}

	// We don't have a primary, so let's get all the terms.
	$terms = get_the_terms( $post_id, $taxonomy );

	// Bail if no terms.
	if ( ! $terms || is_wp_error( $terms ) ) {
		return false;
	}

	// Return the first term.
	return $terms[0];
}

function spurs_get_excerpt_by_post($id, $length = 70) {

The return type could not be reliably inferred; please add a @return annotation.

	$content = get_the_content($id);

	if (null !== get_the_excerpt($id) && '' !== get_the_excerpt($id)) {
		$content = get_the_excerpt($id);
	}

	$content = strip_tags($content, '<ul><li>');
	$content = strip_shortcodes($content);
	if ( strlen($content) > $length ) {
		return substr($content, 0, $length) . '[..]';
	} else {
		return $content;
	}
}

// Enables the confirmation anchor on all Gravity Forms.
add_filter( 'gform_confirmation_anchor', '__return_true' );

/**
 * Remove comment below in order to create CPTs and Taxonomies dynamically.
 */

//add_action( 'init', 'spurs_register_cpt_taxonomies');
function spurs_register_cpt_taxonomies()
{
	spurs_register_cpts();
	spurs_register_taxonomies();
}

function spurs_register_cpts(){

This function seems to be duplicated in your project.

    $cpts[] = array(
		'name'  => 'report',
		'names' => array(
			'singular'      => 'report',
			'plural'        => 'reports',
			'uc_singular'   => 'Report',
			'uc_plural'     => 'Reports',
		),
		'icon'  => 'analytics'
	);

	if ( count( $cpts ) > 0 ) {
		foreach ( $cpts as $cpt ) {
			$cpt_obj = new Spurs_CPT_Creator();
			$cpt_obj->register_cpt( $cpt['name'], $cpt['names'], $cpt['icon'] );
		}
	}
}

function spurs_register_taxonomies() {

This function seems to be duplicated in your project.

	$taxonomies[] = array(
		'name'      => 'report-type',
		'post_type' => 'report',
		'names'     => array(
			'singular'      => 'report-type',
			'plural'        => 'report-types',
			'uc_singular'   => 'Report Type',
			'uc_plural'     => 'Report Types',
		),
		'hierarchical'  => true
	);

	if ( count( $taxonomies ) > 0 ) {
		foreach ( $taxonomies as $tax ) {
			$tax_obj = new Spurs_CPT_Creator();
			$tax_obj->register_taxonomy( $tax['name'], $tax['post_type'], $tax['names'], $tax['hierarchical'] );
		}
	}
}