Conform to WP Coding standards, add Travis Linting

Author: Antti Kuosmanen

.travis.yml

@@ -0,0 +1,25 @@
+sudo: false
+language: php
+php:
+  - 5.6
+  - 7.1
+
+cache:
+  directories:
+    - $HOME/.composer/cache
+    - $HOME/.composer/vendor
+    - vendor
+
+before_install:
+  # Update Composer
+  - composer self-update
+
+  # Install phpcs with wp-coding-standards
+  - composer create-project wp-coding-standards/wpcs:dev-master --no-dev $HOME/wpcs
+
+script:
+  # Check project with phps
+  - ~/wpcs/vendor/bin/phpcs --extensions=php --standard=./phpcs.xml -n -p .
+
+  # Check that composer is valid and installs correctly
+  - composer install -o --prefer-dist --no-interaction

classes/class-cpt-wplf-form.php

@@ -1,6 +1,6 @@
 <?php
 
-if ( !class_exists('CPT_WPLF_Submission') ) :
+if ( ! class_exists( 'CPT_WPLF_Submission' ) ) :
 
 class CPT_WPLF_Submission {
   /**
@@ -26,15 +26,16 @@ private function __construct() {
     add_action( 'add_meta_boxes', array( $this, 'add_meta_boxes_cpt' ) );
 
     // edit.php view
-    add_filter( 'manage_edit-wplf-submission_columns' , array( $this, 'custom_columns_cpt' ), 100, 1);
-    add_action( 'manage_posts_custom_column' , array( $this, 'custom_columns_display_cpt' ), 10, 2 );
+    add_filter( 'manage_edit-wplf-submission_columns', array( $this, 'custom_columns_cpt' ), 100, 1 );
+    add_action( 'manage_posts_custom_column', array( $this, 'custom_columns_display_cpt' ), 10, 2 );
     add_action( 'restrict_manage_posts', array( $this, 'form_filter_dropdown' ) );
     add_filter( 'pre_get_posts', array( $this, 'filter_by_form' ) );
 
     // add custom bulk actions
-    add_filter( 'bulk_actions-edit-wplf-submission', array( $this, 'register_wplf_submission_bulk_actions' ) );
-    add_filter( 'handle_bulk_actions-edit-wplf-submission', array( $this, 'wplf_submission_bulk_action_handler' ), 10, 3  );
     add_action( 'admin_notices', array( $this, 'wplf_submission_bulk_action_admin_notice' ) );
+    add_filter( 'bulk_actions-edit-wplf-submission', array( $this, 'register_wplf_submission_bulk_actions' ) );
+    add_filter( 'handle_bulk_actions-edit-wplf-submission',
+      array( $this, 'wplf_submission_bulk_action_handler' ), 10, 3 );
   }
 
   public static function register_cpt() {
@@ -51,7 +52,7 @@ public static function register_cpt() {
       'all_items'          => __( 'Submissions', 'wp-libre-form' ),
       'search_items'       => __( 'Search Submissions', 'wp-libre-form' ),
       'not_found'          => __( 'No submissions found.', 'wp-libre-form' ),
-      'not_found_in_trash' => __( 'No submissions found in Trash.', 'wp-libre-form' )
+      'not_found_in_trash' => __( 'No submissions found in Trash.', 'wp-libre-form' ),
     );
 
     $args = array(
@@ -67,7 +68,7 @@ public static function register_cpt() {
       'has_archive'        => false,
       'hierarchical'       => false,
       'menu_position'      => null,
-      'supports'           => array( 'title', 'custom-fields' )
+      'supports'           => array( 'title', 'custom-fields' ),
     );
 
     register_post_type( 'wplf-submission', $args );
@@ -78,15 +79,17 @@ public static function register_cpt() {
    * Custom column display for Submission CPT in edit.php
    */
   function custom_columns_display_cpt( $column, $post_id ) {
-    if( 'referrer' === $column ) {
-      if( $referrer = get_post_meta($post_id, 'referrer', true) ) {
+    if ( 'referrer' === $column ) {
+      if ( $referrer = get_post_meta( $post_id, 'referrer', true ) ) {
         echo '<a href="' . esc_url_raw( $referrer ) . '">' . esc_url( $referrer ) . '</a>';
       }
     }
-    if( 'form' === $column ) {
-      if( $form_id = get_post_meta($post_id, '_form_id', true) ) {
+    if ( 'form' === $column ) {
+      if ( $form_id = get_post_meta( $post_id, '_form_id', true ) ) {
         $form = get_post( $form_id );
-        echo '<a href="' . get_edit_post_link( $form_id, '' ) . '" target="_blank">' . esc_html( $form->post_title ) . '</a>';
+        echo '<a href="' . esc_url_raw( get_edit_post_link( $form_id, '' ) ). '" target="_blank">';
+        echo esc_html( $form->post_title );
+        echo '</a>';
       }
     }
   }
@@ -111,35 +114,36 @@ function custom_columns_cpt( $columns ) {
   function form_filter_dropdown() {
     global $pagenow;
 
-    $allowed = array("wplf-submission"); // show filter on these post types (currently only one?)
-    $allowed = apply_filters("wplf-dropdown-filter", $allowed);
-    $post_type = get_query_var("post_type");
+    $allowed = array( 'wplf-submission' ); // show filter on these post types (currently only one?)
+    $allowed = apply_filters( 'wplf-dropdown-filter', $allowed );
+    $post_type = get_query_var( 'post_type' );
 
-    if( 'edit.php' != $pagenow || !in_array($post_type, $allowed)) {
+    if ( 'edit.php' !== $pagenow || ! in_array( $post_type, $allowed, true ) ) {
       return;
     }
 
-    $transient = get_transient("wplf-form-filter");
+    $transient = get_transient( 'wplf-form-filter' );
 
-    if($transient){
+    if ( $transient ) {
       $forms = $transient;
-    }
-
-    else{
+    } else {
       $forms = get_posts( array(
         'post_per_page' => '-1',
         'post_type' => 'wplf-form',
       ) );
 
-      set_transient("wplf-form-filter", $forms, 15 *  MINUTE_IN_SECONDS);
+      set_transient( 'wplf-form-filter', $forms, 15 * MINUTE_IN_SECONDS );
     }
 
 ?>
 <label for="filter-by-form" class="screen-reader-text">Filter by form</label>
 <select name="form" id="filter-by-form">
-  <option value="0"><?php _e('All Forms', 'wp-libre-form'); ?></option>
-  <?php foreach( $forms as $form ) : ?>
-  <option value="<?php echo $form->ID; ?>" <?php echo isset( $_REQUEST['form'] ) && $_REQUEST['form'] == $form->ID ? 'selected' : ''; ?>><?php echo $form->post_title; ?></option>
+  <option value="0"><?php esc_html_e( 'All Forms', 'wp-libre-form' ); ?></option>
+  <?php foreach ( $forms as $form ) : ?>
+    <option
+      value="<?php echo intval( $form->ID ); ?>"
+      <?php echo isset( $_REQUEST['form'] ) && intval( $_REQUEST['form'] ) === $form->ID ? 'selected' : ''; ?>
+    ><?php esc_html( $form->post_title ); ?></option>
   <?php endforeach; ?>
 </select>
 <?php
@@ -151,15 +155,15 @@ function form_filter_dropdown() {
   function filter_by_form( $query ) {
     global $pagenow;
 
-    if( 'edit.php' != $pagenow ) {
+    if ( 'edit.php' !== $pagenow ) {
       return $query;
     }
 
-    if( $query->get( 'post_type' ) != 'wplf-submission' ) {
+    if ( $query->get( 'post_type' ) !== 'wplf-submission' ) {
       return $query;
     }
 
-    if( isset( $_REQUEST['form'] ) && ! empty( $_REQUEST['form'] ) ) {
+    if ( isset( $_REQUEST['form'] ) && ! empty( $_REQUEST['form'] ) ) {
       $query->set( 'meta_key', '_form_id' );
       $query->set( 'meta_value', intval( $_REQUEST['form'] ) );
     }
@@ -168,16 +172,16 @@ function filter_by_form( $query ) {
   }
 
   function register_wplf_submission_bulk_actions( $bulk_actions ) {
-    $bulk_actions['wplf_resend_copy'] = __('Resend email copy', 'wp-libre-form');
+    $bulk_actions['wplf_resend_copy'] = __( 'Resend email copy', 'wp-libre-form' );
     return $bulk_actions;
   }
 
   function wplf_submission_bulk_action_handler( $redirect_to, $doaction, $post_ids ) {
-    if( $doaction !== 'wplf_resend_copy' ) {
+    if ( $doaction !== 'wplf_resend_copy' ) {
       return $redirect_to;
     }
 
-    foreach( $post_ids as $post_id ) {
+    foreach ( $post_ids as $post_id ) {
       $return = new stdClass();
       $return->ok = 1;
 
@@ -189,14 +193,18 @@ function wplf_submission_bulk_action_handler( $redirect_to, $doaction, $post_ids
   }
 
   function wplf_submission_bulk_action_admin_notice() {
-    if( !empty( $_REQUEST['wplf_resent'] ) ) {
+    if ( ! empty( $_REQUEST['wplf_resent'] ) ) {
       $count = intval( $_REQUEST['wplf_resent'] );
-      printf( '<div id="wplf-submission-bulk-resend-message" class="notice notice-success"><p>' .
-        _n( 'Resent email copy of %s submission.',
-          'Resent email copy of %s submissions.',
-          $count,
-          'wp-libre-form'
-        ) . '</p></div>', $count );
+      printf(
+        '<div id="wplf-submission-bulk-resend-message" class="notice notice-success"><p>' .
+         esc_html__(
+           _n( 'Resent email copy of %s submission.',
+               'Resent email copy of %s submissions.',
+               $count ),
+           'wp-libre-form'
+        ) . '</p></div>',
+        intval( $count )
+      );
     }
   }
 
@@ -228,13 +236,13 @@ function metabox_submission() {
   <table class="wp-list-table widefat striped">
     <thead>
       <tr>
-        <th><strong><?php _e( 'Field', 'wp-libre-form' ); ?></strong></th>
-        <th><strong><?php _e( 'Value', 'wp-libre-form' ); ?></strong></th>
+        <th><strong><?php esc_html_e( 'Field', 'wp-libre-form' ); ?></strong></th>
+        <th><strong><?php esc_html_e( 'Value', 'wp-libre-form' ); ?></strong></th>
       </tr>
     </thead>
     <tbody>
-      <?php foreach( $fields as $field ) : ?>
-        <?php if( '_' != $field[0]  ) : ?>
+      <?php foreach ( $fields as $field ) : ?>
+        <?php if ( '_' !== $field[0]  ) : ?>
         <?php
         $value = $postmeta[ $field ][0];
 
@@ -243,9 +251,12 @@ function metabox_submission() {
 
         // if the field ends with '_attachment' and there is an attachment url that corresponds to the id, show a link
         $attachment_suffix = '_attachment';
-        if ( substr( $field, -strlen( $attachment_suffix ) ) === $attachment_suffix && wp_get_attachment_url( $value ) ) {
-          $link_text = __( 'View Attachment', 'wp-libre-form' );
-          $possible_link = '<a target="_blank" href="' . get_edit_post_link( $value ) . '" style="float:right">' . $link_text . '</a>';
+        if ( substr( $field, -strlen( $attachment_suffix ) ) === $attachment_suffix ) {
+          if ( wp_get_attachment_url( $value ) ) {
+            $link_text = __( 'View Attachment', 'wp-libre-form' );
+            $possible_link = '<a target="_blank" href="' . get_edit_post_link( $value ) . '" style="float:right">';
+            $possible_link .= $link_text . '</a>';
+          }
         }
 
         // Show a link if the field corresponds to a URL
@@ -257,8 +268,8 @@ function metabox_submission() {
         }
         ?>
         <tr>
-          <th><strong><?php echo $field; ?></strong> <?php echo $possible_link; ?></th>
-          <?php if( strlen( $value ) > 60 || strpos( $value, "\n" ) ) : ?>
+          <th><strong><?php echo esc_html( $field ); ?></strong> <?php echo wp_kses( $possible_link ); ?></th>
+          <?php if ( strlen( $value ) > 60 || strpos( $value, "\n" ) ) : ?>
           <td><textarea style="width:100%" readonly><?php echo esc_textarea( $value ); ?></textarea></td>
           <?php else : ?>
           <td><input style="width:100%" type="text" value="<?php esc_attr_e( $value ); ?>" readonly></td>

classes/class-cpt-wplf-submission.php

@@ -1,5 +1,5 @@
 <?php
-if ( !class_exists( 'WPLF_Polylang' ) ) {
+if ( ! class_exists( 'WPLF_Polylang' ) ) {
   class WPLF_Polylang {
     /**
      * CPT for the forms
@@ -20,55 +20,55 @@ public static function init() {
      */
     private function __construct() {
       add_filter( 'wplf_form', array( $this, 'render_form' ) );
-      add_filter( 'save_post_wplf-form', array( $this, 'save_form' ), 10, 3);
-      add_action( 'after_setup_theme', array ( $this, 'register_strings') );
+      add_filter( 'save_post_wplf-form', array( $this, 'save_form' ), 10, 3 );
+      add_action( 'after_setup_theme', array( $this, 'register_strings' ) );
 
       $this->strings = get_option( 'wplf-translation-strings', array() );
       $this->register_strings();
     }
 
-    public function render_form ( $form_content ) {
+    public function render_form( $form_content ) {
       // Get all strings inside double curly braces.
       preg_match_all( $this->regular_expression, $form_content, $matches );
-      foreach( $matches[0] as $match ){
+      foreach ( $matches[0] as $match ) {
         // match contains the braces, get rid of them.
-        $string = trim( str_replace( array( "{" , "}" ), array( "", "" ), $match ) );
-        $form_content = str_replace( $match, $this->translate_string ( $string ), $form_content );
+        $string = trim( str_replace( array( '{', '}' ), array( '', '' ), $match ) );
+        $form_content = str_replace( $match, $this->translate_string( $string ), $form_content );
       }
 
       return $form_content;
     }
 
-    function save_form ( $post_id, $post, $update ) {
+    function save_form( $post_id, $post, $update ) {
+      unset( $post_id, $update ); // not used here so shut up linter!
+
       preg_match_all( $this->regular_expression, $post->post_content, $matches );
-      if( !empty( $matches ) ) {
-        foreach( $matches[0] as $match ){
+      if ( ! empty( $matches ) ) {
+        foreach ( $matches[0] as $match ) {
           // match contains the braces, get rid of them.
-          $string = trim( str_replace( array( "{" , "}" ), array( "", "" ), $match ) );
-          $this->strings[$string] = null;
+          $string = trim( str_replace( array( '{', '}' ), array( '', '' ), $match ) );
+          $this->strings[ $string ] = null;
           // By storing the string as the array key, we don't need to use array_unique.
         }
       }
 
       update_option( 'wplf-translation-strings', $this->strings ); // Let's be optimistic.
     }
 
-    public function register_strings () {
-      foreach( $this->strings as $string => $value ) {
+    public function register_strings() {
+      foreach ( $this->strings as $string => $value ) {
         $this->register_string( $string );
       }
     }
 
-    public function register_string ( $string  ) {
-      if( function_exists( 'pll_register_string' ) ) {
+    public function register_string( $string ) {
+      if ( function_exists( 'pll_register_string' ) ) {
         pll_register_string( $string, $string, 'WP Libre Form' );
-      } else {
-        // Don't kill anything.
       }
     }
 
-    public function translate_string ( $string ) {
-      if( function_exists( 'pll__' ) ) {
+    public function translate_string( $string ) {
+      if ( function_exists( 'pll__' ) ) {
         return pll__( $string );
       } else {
         return $string; // Don't kill anything.