Skip to content
Snippets Groups Projects
Commit 45dbce83 authored by Erick Hitter's avatar Erick Hitter
Browse files

PHPCS

parent 8da11a36
No related branches found
No related tags found
1 merge request!13PHPCS fixes
Pipeline #1692 passed with warnings
Stage: test
Stage: deploy
Show whitespace changes
Inline Side-by-side
eth-escape-headspace.php
+ 69
− 41
View file @ 45dbce83
<?php <?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
/* /**
Plugin Name: ETH Escape HeadSpace2 Plugin Name: ETH Escape HeadSpace2
Plugin URI: https://ethitter.com/plugins/ Plugin URI: https://ethitter.com/plugins/
Description: Output existing HeadSpace2 data without the original plugin. Allows HeadSpace2 (no longer maintained) to be deactivated without impactacting legacy content. Description: Output existing HeadSpace2 data without the original plugin. Allows HeadSpace2 (no longer maintained) to be deactivated without impactacting legacy content.
...@@ -22,9 +22,14 @@ along with this program; if not, write to the Free Software ...@@ -22,9 +22,14 @@ along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/ */
/**
* Class ETH_Escape_HeadSpace2.
*/
class ETH_Escape_HeadSpace2 { class ETH_Escape_HeadSpace2 {
/** /**
* Singleton * Singleton
*
* @var self
*/ */
private static $instance = null; private static $instance = null;
...@@ -33,14 +38,16 @@ class ETH_Escape_HeadSpace2 { ...@@ -33,14 +38,16 @@ class ETH_Escape_HeadSpace2 {
*/ */
public static function get_instance() { public static function get_instance() {
if ( ! is_a( self::$instance, __CLASS__ ) ) { if ( ! is_a( self::$instance, __CLASS__ ) ) {
self::$instance = new self; self::$instance = new self();
} }
return self::$instance; return self::$instance;
} }
/** /**
* Class properties * Headspace's string keys.
*
* @var array
*/ */
private $hs_string_keys = array( private $hs_string_keys = array(
'_headspace_description', '_headspace_description',
...@@ -48,11 +55,21 @@ class ETH_Escape_HeadSpace2 { ...@@ -48,11 +55,21 @@ class ETH_Escape_HeadSpace2 {
'_headspace_raw', '_headspace_raw',
); );
/**
* Headspace's array keys.
*
* @var array
*/
private $hs_array_keys = array( private $hs_array_keys = array(
'_headspace_scripts', '_headspace_scripts',
'_headspace_stylesheets', '_headspace_stylesheets',
); );
/**
* robots.txt keys.
*
* @var array
*/
private $hs_robots_keys = array( private $hs_robots_keys = array(
'_headspace_noindex', '_headspace_noindex',
'_headspace_nofollow', '_headspace_nofollow',
...@@ -61,6 +78,11 @@ class ETH_Escape_HeadSpace2 { ...@@ -61,6 +78,11 @@ class ETH_Escape_HeadSpace2 {
'_headspace_noydir', '_headspace_noydir',
); );
/**
* Map Headspace keys.
*
* @var array
*/
private $hs_keys_to_meta_names = array( private $hs_keys_to_meta_names = array(
'_headspace_description' => 'description', '_headspace_description' => 'description',
'_headspace_metakey' => 'keywords', '_headspace_metakey' => 'keywords',
...@@ -80,7 +102,7 @@ class ETH_Escape_HeadSpace2 { ...@@ -80,7 +102,7 @@ class ETH_Escape_HeadSpace2 {
* Conditionally register plugin's hooks * Conditionally register plugin's hooks
*/ */
public function maybe_add_hooks() { public function maybe_add_hooks() {
// Defer to HeadSpace2 when active // Defer to HeadSpace2 when active.
if ( class_exists( 'HeadSpace_Plugin' ) ) { if ( class_exists( 'HeadSpace_Plugin' ) ) {
return; return;
} }
...@@ -93,8 +115,10 @@ class ETH_Escape_HeadSpace2 { ...@@ -93,8 +115,10 @@ class ETH_Escape_HeadSpace2 {
} }
/** /**
* Filter page titles in WP 4.1+ themes * Filter page titles in WP 4.1+ themes add_theme_support( 'title-tag' ).
* add_theme_support( 'title-tag' ) *
* @param string $title Page title.
* @return string
*/ */
public function filter_pre_get_document_title( $title ) { public function filter_pre_get_document_title( $title ) {
$_title = get_post_meta( get_the_ID(), '_headspace_page_title', true ); $_title = get_post_meta( get_the_ID(), '_headspace_page_title', true );
...@@ -109,8 +133,12 @@ class ETH_Escape_HeadSpace2 { ...@@ -109,8 +133,12 @@ class ETH_Escape_HeadSpace2 {
} }
/** /**
* Filter page titles in themes designed for < WP 4.1 * Filter page titles in themes designed for < WP 4.1 wp_title().
* wp_title() *
* @param string $title Object title.
* @param string $sep Title separator.
* @param string $loc Separator location.
* @return string
*/ */
public function filter_wp_title( $title, $sep, $loc ) { public function filter_wp_title( $title, $sep, $loc ) {
$_title = get_post_meta( get_the_ID(), '_headspace_page_title', true ); $_title = get_post_meta( get_the_ID(), '_headspace_page_title', true );
...@@ -118,7 +146,7 @@ class ETH_Escape_HeadSpace2 { ...@@ -118,7 +146,7 @@ class ETH_Escape_HeadSpace2 {
if ( ! empty( $_title ) ) { if ( ! empty( $_title ) ) {
$_title = esc_html( $_title ); $_title = esc_html( $_title );
if ( 'right' == $loc ) { if ( 'right' === $loc ) {
$title = $_title . ' ' . $sep . ' '; $title = $_title . ' ' . $sep . ' ';
} else { } else {
$title = ' ' . $sep . ' ' . $_title; $title = ' ' . $sep . ' ' . $_title;
...@@ -134,15 +162,15 @@ class ETH_Escape_HeadSpace2 { ...@@ -134,15 +162,15 @@ class ETH_Escape_HeadSpace2 {
* Add <head> meta tags * Add <head> meta tags
*/ */
public function action_wp_head() { public function action_wp_head() {
// Applies only to individual post objects // Applies only to individual post objects.
if ( ! is_singular() ) { if ( ! is_singular() ) {
return; return;
} }
// Check for HS data // Check for HS data.
$hs_data = array(); $hs_data = array();
// Keys that only exist once per post // Keys that only exist once per post.
foreach ( array_merge( $this->hs_string_keys, $this->hs_robots_keys ) as $hs_key ) { foreach ( array_merge( $this->hs_string_keys, $this->hs_robots_keys ) as $hs_key ) {
$value = get_post_meta( get_the_ID(), $hs_key, true ); $value = get_post_meta( get_the_ID(), $hs_key, true );
...@@ -151,7 +179,7 @@ class ETH_Escape_HeadSpace2 { ...@@ -151,7 +179,7 @@ class ETH_Escape_HeadSpace2 {
} }
} }
// Keys that can exist multiple times per post // Keys that can exist multiple times per post.
foreach ( $this->hs_array_keys as $hs_key ) { foreach ( $this->hs_array_keys as $hs_key ) {
$values = get_post_meta( get_the_ID(), $hs_key, false ); $values = get_post_meta( get_the_ID(), $hs_key, false );
...@@ -160,12 +188,12 @@ class ETH_Escape_HeadSpace2 { ...@@ -160,12 +188,12 @@ class ETH_Escape_HeadSpace2 {
} }
} }
// Bail if no HS data exists for this post // Bail if no HS data exists for this post.
if ( empty( $hs_data ) ) { if ( empty( $hs_data ) ) {
return; return;
} }
// Handle basic, string-containing keys // Handle basic, string-containing keys.
$output = array(); $output = array();
foreach ( $hs_data as $hs_key => $hs_value ) { foreach ( $hs_data as $hs_key => $hs_value ) {
...@@ -193,7 +221,7 @@ class ETH_Escape_HeadSpace2 { ...@@ -193,7 +221,7 @@ class ETH_Escape_HeadSpace2 {
} }
} }
// Handle robots key, which is build from several meta keys // Handle robots key, which is build from several meta keys.
$robots = array(); $robots = array();
foreach ( $this->hs_robots_keys as $hs_robot_key ) { foreach ( $this->hs_robots_keys as $hs_robot_key ) {
...@@ -212,8 +240,8 @@ class ETH_Escape_HeadSpace2 { ...@@ -212,8 +240,8 @@ class ETH_Escape_HeadSpace2 {
$output[] = '<meta name="robots" content="' . esc_attr( $robots ) . '" />' . "\n"; $output[] = '<meta name="robots" content="' . esc_attr( $robots ) . '" />' . "\n";
} }
// Raw output should follow all other output // Raw output should follow all other output.
if ( isset( $hs_data[ '_headspace_raw' ] ) && ! empty( $hs_data[ '_headspace_raw' ] ) ) { if ( ! empty( $hs_data[ '_headspace_raw' ] ) ) {
$output[] = $hs_data[ '_headspace_raw' ]; $output[] = $hs_data[ '_headspace_raw' ];
} }
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment