theme-optimizations.php ➔ wpcom_better_footer_links()

Complexity

Conditions	16
Paths	289

Size

Total Lines	144
Code Lines	83

Duplication

Lines	3
Ratio	2.08 %

Importance

Changes

0

<?php
function wpcom_better_footer_links( $footer ) {
	// Only add theme and colophon links for pub and premium themes, and VIP "partner" themes.
	if ( ! wpcom_is_pub_theme() && ! wpcom_is_premium_theme() && ! wpcom_is_vip_theme() && ! wpcom_is_a8c_theme() ) {
		return $footer;
	}

	// Get current theme data.
	$theme = wp_get_theme();

	// Replace separator from content, since we are replacing theme and designer credits.
	// Any span separator with a .sep class will be matched and replaced by the regular expression.
	$footer = preg_replace("/\s\|\s(?=\<a)|\<span class=\"([^\"]+\s)?sep(\s[^\"]+)?\">.*<\/span>/i", '', $footer);

	// Handle WP.com footer text.
	$lang = get_bloginfo( 'language' );

	$_blog_id = get_current_blog_id();
	$vertical = site_vertical( $_blog_id );

	$noads = defined( 'NOADVERTS' ) || defined( 'NOADSUPGRADE' );
	if ( $vertical ) {
		if ( $noads ) {
			$credit_link = sprintf( '<a href="%s">%s.</a>', localized_wpcom_url( 'https://wordpress.com/' . $vertical . '/?ref=vertical_footer', $lang ), __( 'Blog at WordPress.com' ) );
		} else {
			$credit_link = sprintf( '<a href="%s">%s.</a>', localized_wpcom_url( 'https://wordpress.com/' . $vertical . '/?ref=vertical_footer', $lang ), __( 'Create a free website at WordPress.com' ) );
		}
	} else if ( $noads || mt_rand( 0, 1 ) ) {
		$credit_link = sprintf( '<a href="%s">%s.</a>', localized_wpcom_url( 'https://wordpress.com/?ref=footer_blog', $lang ), __( 'Blog at WordPress.com' ) );
	} else {
		$credit_link = sprintf( '<a href="%s">%s.</a>', localized_wpcom_url( 'https://wordpress.com/?ref=footer_website', $lang ), __( 'Create a free website or blog at WordPress.com' ) );
	}

	// Replace credit link in footer, and make sure it is replaced only once, to avoid duplicates.
	$credit_link = apply_filters( 'wpcom_better_footer_credit_link', $credit_link, $lang );

	// The regular expression to match the credit link replacement.
	$credit_regex = implode( '', array(
		'#' , // Open delimiter
			'<a[^>]*href="http(s?)://(([a-z]{2}|www)\.)?(wordpress|wordpress-fr|wpfr)\.(com|org|net)/?"([^>]+)?>' , // Opening link tag
			    '\s*'   , // Optional whitespace
			    '(.+?)' , // Any word or sentence
			    '\s*'   , // Optional whitespace
			'</a>'      , // Closing link tag
			'\.?'       , // Optional period
			'(\s*&[^;]+;\s*)?' , // Optional HTML Entity
		'#i' , // Ending delimiter & modifier
	) );

	// Add filter for specific themes that may need to tweak the regex a bit.
	$credit_regex = apply_filters( 'wpcom_better_footer_credit_regex', $credit_regex, $theme );

	// Get the full matches of the credit regular expression, proceed if match.
	if ( preg_match_all( $credit_regex, $footer, $matches, PREG_OFFSET_CAPTURE ) ) {

		// Get last match and offset.
		$match = array_pop( $matches[0] );
		$offset = $match[1];

		// Split the content into two parts, which we will join later on.
		$before = substr( $footer, 0, $offset );
		$after = substr( $footer, $offset );

		// Replace on the last part. Ensure we only do one replacement to avoid duplicates.
		$after = preg_replace( $credit_regex, $credit_link, $after, 1 );

		// Join the two parts.
		$footer = $before . $after;

	}

	// Themes that have duplicate footer credit links (e.g. "Powered by WordPress.com" + another credit link).
	$powered_by_themes = array(
		'pub/toujours',
	);

	// Remove "Proudly powered by WordPress" on selected themes.
	if ( in_array( $theme->stylesheet, $powered_by_themes ) ) {
		$powered_string = preg_quote( __( 'Proudly powered by WordPress' ), '#' );
		$powered_regex = sprintf( '#<a[^>]*href="http(s?)://(([a-z]{2}|www)\.)?wordpress\.(com|org)/?"([^>]+)?>%s</a>\.?#i', $powered_string );
		$footer = preg_replace( $powered_regex, '', $footer );
	}

	// Only add theme and colophon link for pub and premium themes.
	if ( wpcom_is_vip_theme() ) {
		return $footer;
	}

	// Handle adding Theme Name and colophon link to footer text.
	$theme_match = sprintf(
		'(?:\s*\|\s*)?'       . // Optional pipe with spaces (non-capturing)
		'(?:<span\s[^>]+>)?'  . // Optional opening span tag (non-capturing)
		'(Theme|%s)'          . // $1: "Theme" or the localized equivalent
		'\s*(?:&nbsp;)?:\s*'  . // Zero or more whitespace characters, a colon, zero or more whitespace characters
		'(%s|<a[^>]+>%s</a>)' . // $2: The theme name, or link
		'\.?'                 . // Optional period
		'(?:</span>)?'        . // Optional closing span tag (non-capturing)
		'\.?'                   // Optional period

		, preg_quote( __( 'Theme' ), '#' )
		, preg_quote( $theme->name, '#' )
		, preg_quote( $theme->name, '#' )
	);

	// Theme designer match.
	$designer_match = $theme_match . sprintf(
		'('                       . // Start $3
		    '\s*'                 . // Zero or more whitespace characters
		    '(?:<span\s[^>]+>)?'  . // Optional opening span tag (non-capturing)
		    '(?:by|%s)'           . // "by" or the localized equivalent (non-capturing)
		    '(?:</span>)?'        . // Optional closing span tag (non-capturing)
		    '\s*'                 . // Zero or more whitespace characters
		    '(<a[^>]+>.+?</a>)?'  . // $4: Maybe a full <a> element
		')'                       . // End $3
		'\.?'                       // Optional period

		, preg_quote( __( 'by' ), '#' ) // localized "by" preposition
	);

	// Match "Design by <shop>".
	$design_by = preg_quote( $credit_link, '#' ) . sprintf(
		'\.?'                . // Optional period
		'\s*'                . // Optional whitespace
		'(Design by|%s)'     . // "Design by" or localized equivalent
		'\s*'                . // Optional whitespace
		'(<a[^>]+>.+?</a>)'  . // Full link element
		'\.?'                  // Optional period

		, preg_quote( __( 'Design by' ), '#' )
	);

	if ( preg_match( "#$designer_match#i", $footer ) ) {
		$footer = preg_replace( "#$designer_match#i", '', $footer, 1 );
	}

	if ( preg_match( "#$theme_match#i", $footer ) ) {
		$footer = preg_replace( "#$theme_match#i", '', $footer, 1 );
	}

	if ( preg_match( "#$design_by#i", $footer ) ) {
		$footer = preg_replace( "#$design_by#i", $credit_link, $footer, 1 );
	}

	return $footer;
}