PHPCS fixes for 1.9.1-dev

.travis.yml

@@ -39,6 +39,7 @@ before_script:
     - if [[ "$SNIFF" == "1" ]]; then git clone -b master --depth 1 https://github.com/squizlabs/PHP_CodeSniffer.git $PHPCS_DIR; fi
     # Install WordPress Coding Standards.
     - if [[ "$SNIFF" == "1" ]]; then git clone -b master --depth 1 https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards.git $SNIFFS_DIR; fi
+    - if [[ "$SNIFF" == "1" ]]; then git clone -b master --depth 1 https://github.com/Automattic/VIP-Coding-Standards.git $SNIFFS_DIR; fi
     # Install PHP Compatibility sniffs.
     - if [[ "$SNIFF" == "1" ]]; then git clone -b master --depth 1 https://github.com/wimg/PHPCompatibility.git $SNIFFS_DIR/PHPCompatibility; fi
     # Set install path for PHPCS sniffs.

README.md

@@ -12,7 +12,7 @@
 
 [![Build Status](https://travis-ci.org/Automattic/liveblog.svg?branch=master)](https://travis-ci.org/Automattic/liveblog)
 
-Quick and simple blogging for following fast-paced events.
+Empowers website owners to provide rich and engaging live event coverage to a large, distributed audience.
 
 ## Description
 

classes/class-wpcom-liveblog-amp-template.php

@@ -33,7 +33,7 @@ class WPCOM_Liveblog_AMP_Template {
 	 *
 	 * @return void
 	 */
-	public function __contrust() {
+	public function __construct() {
 		$this->theme_template_path  = apply_filters( 'liveblog_amp_theme_template_path', $this->theme_template_path );
 		$this->plugin_template_path = apply_filters( 'liveblog_amp_plugin_template_path', $this->plugin_template_path );
 	}
@@ -75,14 +75,14 @@ public function render( $name, $variables = array() ) {
 			$path = $plugin;
 		}
 
-		if ( $path === false ) {
+		if ( false === $path ) {
 			return 'Template Not Found: ' . $name;
 		}
 
 		$this->data = $variables;
 
 		ob_start();
-		include $path;
+		include $path; // phpcs:ignore WordPressVIPMinimum.Files.IncludingFile.IncludingFile
 		return ob_get_clean();
 	}
 

classes/class-wpcom-liveblog-amp.php

@@ -31,8 +31,6 @@ public static function load() {
 
 	/**
 	 * AMP Setup by removing and adding new hooks.
-	 *
-	 * @return void
 	 */
 	public static function setup() {
 		// If we're not on an AMP page then bail.
@@ -112,7 +110,7 @@ public static function print_styles() {
 	 * @return void
 	 */
 	public static function enqueue_styles() {
-		wp_enqueue_style( 'liveblog', plugin_dir_url( __DIR__ ) . 'assets/amp.css' );
+		wp_enqueue_style( 'liveblog', plugin_dir_url( __DIR__ ) . 'assets/amp.css', array(), WPCOM_Liveblog::VERSION );
 	}
 
 
@@ -138,7 +136,7 @@ public static function social_meta_tags() {
 
 		$entry       = self::get_entry( $request->id, $post->ID );
 		$title       = WPCOM_Liveblog_Entry::get_entry_title( $entry );
-		$description = strip_tags( $entry->content );
+		$description = wp_strip_all_tags( $entry->content );
 		$url         = self::build_single_entry_permalink( amp_get_permalink( $post->ID ), $entry->id );
 		$image       = self::get_entry_image( $entry );
 
@@ -191,7 +189,7 @@ public static function append_liveblog_to_metadata( $metadata, $post ) {
 			/**
 			 * This filter is documented in liveblog.php
 			 */
-			$metadata = WPCOM_Liveblog::get_liveblog_metadata();
+			$metadata = WPCOM_Liveblog::get_liveblog_metadata( $metadata, $post );
 		}
 
 		return $metadata;
@@ -262,7 +260,8 @@ public static function build_single_entry( $entries, $request, $post_id ) {
 		}
 
 		$rendered = self::get_template(
-			'entry', array(
+			'entry',
+			array(
 				'single'         => true,
 				'id'             => $entry->id,
 				'content'        => $entry->content,
@@ -315,7 +314,8 @@ public static function get_entry( $id, $post_id, $entries = false ) {
 	 */
 	public static function build_entries_feed( $entries, $request, $post_id ) {
 		$rendered = self::get_template(
-			'feed', array(
+			'feed',
+			array(
 				'entries'  => self::filter_entries( $entries['entries'], $post_id ),
 				'post_id'  => $post_id,
 				'page'     => $entries['page'],
@@ -395,7 +395,7 @@ public static function get_pagination_links( $request, $pages, $post_id ) {
 
 		$links['prev'] = false;
 		if ( $request->page > 1 ) {
-			$keep_postion  = ( (int) $request->page === 2 ) ? false : $request->last;
+			$keep_postion  = ( 2 === (int) $request->page ) ? false : $request->last;
 			$links['prev'] = self::build_paged_permalink( $permalink, $request->page - 1, $keep_postion );
 		}
 
@@ -420,7 +420,8 @@ public static function build_paged_permalink( $permalink, $page, $last ) {
 			array(
 				'liveblog_page' => $page,
 				'liveblog_last' => $last,
-			), $permalink
+			),
+			$permalink
 		);
 	}
 
@@ -435,7 +436,8 @@ public static function build_single_entry_permalink( $permalink, $id ) {
 		return add_query_arg(
 			array(
 				'liveblog_id' => $id,
-			), $permalink
+			),
+			$permalink
 		);
 	}
 
@@ -458,6 +460,6 @@ public static function get_template( $name, $variables = array() ) {
 	 */
 	public static function is_amp_polling() {
 		// phpcs:ignore WordPress.Security.NonceVerification.NoNonceVerification
-		return isset( $_GET[ self::AMP_UPDATE_QUERY_VAR ] );
+		return isset( $_GET[ self::AMP_UPDATE_QUERY_VAR ] ); // phpcs:ignore WordPress.VIP.SuperGlobalInputUsage.AccessDetected
 	}
 }

classes/class-wpcom-liveblog-cron.php

@@ -44,7 +44,7 @@ public static function execute_auto_archive_housekeeping() {
 				array(
 					'order'    => 'ASC',
 					'orderby'  => 'ID',
-					'meta_key' => 'liveblog',
+					'meta_key' => 'liveblog', // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key
 				)
 			);
 

classes/class-wpcom-liveblog-entry-embed-sdks.php

@@ -39,7 +39,7 @@ public static function enqueue() {
 		}
 
 		foreach ( self::$sdks as $name => $url ) {
-			wp_enqueue_script( $name, esc_url( $url ), false );
+			wp_enqueue_script( $name, esc_url( $url ), array(), WPCOM_Liveblog::VERSION, false );
 		}
 	}
 

classes/class-wpcom-liveblog-entry-embed.php

@@ -77,8 +77,8 @@ public function shortcode( $attr, $url = '', $comment = null ) {
 			$handlers = array_replace_recursive( $GLOBALS['wp_embed']->handlers, $this->handlers );
 		}
 		ksort( $handlers );
-		foreach ( $handlers as $priority => $handlers ) {
-			foreach ( $handlers as $id => $handler ) {
+		foreach ( $handlers as $handlers ) {
+			foreach ( $handlers as $handler ) {
 				if ( preg_match( $handler['regex'], $url, $matches ) && is_callable( $handler['callback'] ) ) {
 					$return = call_user_func( $handler['callback'], $matches, $attr, $url, $rawattr );
 					if ( false !== $return ) {

classes/class-wpcom-liveblog-entry-extend-feature-authors.php

@@ -45,7 +45,8 @@ public function load() {
 		// generated author html back to the
 		// raw input format (e.g @author).
 		$this->revert_regex = implode(
-			'', array(
+			'',
+			array(
 				preg_quote( '<a href="', '~' ),
 				'[^"]+',
 				preg_quote( '" class="liveblog-author ', '~' ),
@@ -87,7 +88,8 @@ public function get_config( $config ) {
 		// config, after first allowing other plugins,
 		// themes, etc. to modify it as required
 		$config[] = apply_filters(
-			'liveblog_author_config', array(
+			'liveblog_author_config',
+			array(
 				'type'        => 'ajax',
 				'cache'       => 1000 * 60 * 30,
 				'url'         => esc_url( $endpoint_url ),
@@ -198,7 +200,7 @@ public function add_author_class_to_entry( $classes, $class, $comment_id ) {
 		if ( WPCOM_Liveblog::KEY === $comment->comment_type ) {
 
 			// Grab all the prefixed classes applied.
-			preg_match_all( '/(?<!\w)' . preg_quote( $this->class_prefix ) . '\w+/', $comment->comment_content, $authors );
+			preg_match_all( '/(?<!\w)' . preg_quote( $this->class_prefix, '/' ) . '\w+/', $comment->comment_content, $authors );
 
 			// Append the first class to the classes array.
 			$classes = array_merge( $classes, $authors[0] );

classes/class-wpcom-liveblog-entry-extend-feature-commands.php

@@ -62,7 +62,8 @@ public function load() {
 		// generated author html back to the
 		// raw input format (e.g /key).
 		$this->revert_regex = implode(
-			'', array(
+			'',
+			array(
 				preg_quote( '<span class="liveblog-command ', '~' ),
 				preg_quote( $this->class_prefix_local, '~' ),
 				'([^"]+)',
@@ -103,7 +104,8 @@ public function get_config( $config ) {
 		// config, after first allowing other plugins,
 		// themes, etc. to modify it as required
 		$config[] = apply_filters(
-			'liveblog_command_config', array(
+			'liveblog_command_config',
+			array(
 				'trigger'     => '/',
 				'data'        => $this->get_commands(),
 				'displayKey'  => false,

classes/class-wpcom-liveblog-entry-extend-feature-emojis.php

@@ -914,7 +914,8 @@ public function load() {
 		// generated emoji html back to the
 		// raw input format (e.g :poop:).
 		$this->revert_regex = implode(
-			'', array(
+			'',
+			array(
 				preg_quote( '<img src="', '~' ),
 				preg_quote( $this->emoji_cdn, '~' ),
 				'[^"]+',
@@ -952,7 +953,8 @@ public function get_config( $config ) {
 		// config, after first allowing other plugins,
 		// themes, etc. to modify it as required
 		$config[] = apply_filters(
-			'liveblog_emoji_config', array(
+			'liveblog_emoji_config',
+			array(
 				'type'        => 'static',
 				'data'        => $emojis,
 				'search'      => 'key',
@@ -984,7 +986,8 @@ public function map_emoji( $val, $key ) {
 		// Then pass it into a filter to allow plugins,
 		// themes, etc. to customise the output.
 		return apply_filters(
-			'liveblog_emoji_map', array(
+			'liveblog_emoji_map',
+			array(
 				'key'   => $key,
 				'name'  => $key,
 				'image' => strtolower( $val ),
@@ -1093,7 +1096,7 @@ public function add_emoji_class_to_entry( $classes, $class, $comment_id ) {
 		if ( WPCOM_Liveblog::KEY === $comment->comment_type ) {
 
 			// Grab all the prefixed classes applied.
-			preg_match_all( '/(?<!\w)' . preg_quote( $this->class_prefix ) . '\w+/', $comment->comment_content, $emojis );
+			preg_match_all( '/(?<!\w)' . preg_quote( $this->class_prefix, '/' ) . '\w+/', $comment->comment_content, $emojis );
 
 			// Append the first class to the classes array.
 			$classes = array_merge( $classes, $emojis[0] );

classes/class-wpcom-liveblog-entry-extend-feature-hashtags.php

@@ -43,7 +43,8 @@ public function load() {
 		// generated hashtag html back to the
 		// raw input format (e.g #hashtag).
 		$this->revert_regex = implode(
-			'', array(
+			'',
+			array(
 				preg_quote( '<span class="liveblog-hash ', '~' ),
 				preg_quote( $this->class_prefix, '~' ),
 				'([^"]+)',
@@ -87,7 +88,8 @@ public function get_config( $config ) {
 		// config, after first allowing other plugins,
 		// themes, etc. to modify it as required
 		$config[] = apply_filters(
-			'liveblog_hashtag_config', array(
+			'liveblog_hashtag_config',
+			array(
 				'type'        => 'ajax',
 				'cache'       => 1000 * 60,
 				'regex'       => '#([\w\d\-]*)$',
@@ -142,7 +144,7 @@ public function preg_replace_callback( $match ) {
 
 		// If it doesn't exist, then make it.
 		if ( ! get_term_by( 'slug', $hashtag, self::$taxonomy ) ) {
-			$error = wp_insert_term( $hashtag, self::$taxonomy );
+			wp_insert_term( $hashtag, self::$taxonomy );
 		}
 
 		// Replace the #hashtag content with a styled
@@ -180,7 +182,7 @@ public function add_term_class_to_entry( $classes, $class, $comment_id ) {
 		if ( WPCOM_Liveblog::KEY === $comment->comment_type ) {
 
 			// Grab all the prefixed classes applied.
-			preg_match_all( '/(?<!\w)' . preg_quote( $this->class_prefix ) . '(\w\-?)+/', $comment->comment_content, $terms );
+			preg_match_all( '/(?<!\w)' . preg_quote( $this->class_prefix, '/' ) . '(\w\-?)+/', $comment->comment_content, $terms );
 
 			// Append the first class to the classes array.
 			$classes = array_merge( $classes, $terms[0] );
@@ -259,7 +261,7 @@ public function remove_name_search( $clauses ) {
 		// Remove the where clause's section about the name.
 		$clauses['where'] = preg_replace(
 			array(
-				'~\\(\\(.*(?=' . preg_quote( "(t.slug LIKE '" ) . ')~',
+				'~\\(\\(.*(?=' . preg_quote( "(t.slug LIKE '", '~' ) . ')~',
 				'~(%\'\\))\\)~',
 			),
 			'($1',

classes/class-wpcom-liveblog-entry-key-events.php

@@ -150,9 +150,6 @@ public static function render_key_template( $entry, $object ) {
 		// Get the entry content
 		$content = $object->get_content();
 
-		// Use the currently set template.
-		$template = self::get_current_template( $post_id );
-
 		// Set if key event
 		$entry['key_event'] = self::is_key_event( $entry['id'] );
 
@@ -219,7 +216,8 @@ public static function add_admin_options( $extra_fields, $post_id ) {
 
 		// Add the custom template fields to the editor.
 		$extra_fields[] = WPCOM_Liveblog::get_template_part(
-			'liveblog-key-admin.php', array(
+			'liveblog-key-admin.php',
+			array(
 				'current_key_template' => get_post_meta( $post_id, self::META_KEY_TEMPLATE, true ),
 				'current_key_format'   => get_post_meta( $post_id, self::META_KEY_FORMAT, true ),
 				'current_key_limit'    => get_post_meta( $post_id, self::META_KEY_LIMIT, true ),
@@ -307,7 +305,7 @@ public static function format_content_first_sentence( $content ) {
 		$content = preg_replace( '/(.*?[?!.](?=\s|$)).*/', '\\1', $content );
 
 		// Strip it of all non-accepted tags.
-		$content = strip_tags( $content, '<strong></strong><em></em><span></span><img>' );
+		$content = wp_strip_all_tags( $content, '<strong></strong><em></em><span></span><img>' );
 
 		return $content;
 	}
@@ -328,7 +326,7 @@ public static function format_content_first_linebreak( $content ) {
 		$content = explode( '<br />', $content );
 
 		// Strip it of all non-accepted tags.
-		$content = strip_tags( $content[0], '<strong></strong><em></em><span></span><img>' );
+		$content = wp_strip_all_tags( $content[0], '<strong></strong><em></em><span></span><img>' );
 
 		return $content;
 	}
@@ -350,13 +348,14 @@ public static function shortcode( $atts ) {
 		$atts = shortcode_atts(
 			array(
 				'title' => 'Key Events',
-			), $atts
+			),
+			$atts
 		);
 
 		// The args to pass into the entry query.
 		$args = array(
-			'meta_key'   => self::META_KEY,
-			'meta_value' => self::META_VALUE,
+			'meta_key'   => self::META_KEY, // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key
+			'meta_value' => self::META_VALUE, // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_value
 		);
 
 		$limit = get_post_meta( $post->ID, self::META_KEY_LIMIT, true );
@@ -378,7 +377,8 @@ public static function shortcode( $atts ) {
 
 			// Render the actual template.
 			return WPCOM_Liveblog::get_template_part(
-				'liveblog-key-events.php', array(
+				'liveblog-key-events.php',
+				array(
 					'entries'  => $entries,
 					'title'    => $atts['title'],
 					'template' => $template[0],
@@ -398,7 +398,7 @@ public static function all() {
 		$query      = new WPCOM_Liveblog_Entry_Query( WPCOM_Liveblog::$post_id, WPCOM_Liveblog::KEY );
 		$key_events = $query->get(
 			array(
-				'meta_query' => array(
+				'meta_query' => array( // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query
 					array(
 						'key'     => self::META_KEY,
 						'value'   => self::META_VALUE,

classes/class-wpcom-liveblog-entry-query.php

@@ -8,7 +8,6 @@
 class WPCOM_Liveblog_Entry_Query {
 
 	public function __construct( $post_id, $key ) {
-		global $wp_version;
 		$this->post_id = $post_id;
 		$this->key     = $key;
 	}
@@ -44,7 +43,7 @@ public function get_all_edits( $args = array() ) {
 		$defaults = array(
 			'orderby'  => 'comment_date_gmt',
 			'order'    => 'ASC',
-			'meta_key' => 'liveblog_replaces',
+			'meta_key' => 'liveblog_replaces', // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key
 			'status'   => 'liveblog',
 		);