Oftentimes, the way in which we write code depends on how we got started with programming.
For example, if someone has a formal education in computing, they are likely to know a variety of principles that will prevent them from writing poor quality code. This isn't a rule, of course, but an observation.
Similarly, those who get into programming on their own, outside of a formal setting, often end up teaching themselves and learning from a variety of different resources. Sometimes, this can cause problems with the type of code that's written.
To be absolutely clear: I am not saying that a formal education in computing trumps someone who teaches themselves, nor vice versa. Some fantastic programmers are those who are educated; others are those who are self-taught. But the one thing both have in common with one another is that they are not exempt from writing code smells from time to time.
In this article, we're going to take an introductory look at code smells. We're going to examine what they are, what they look like, and how they often manifest themselves in the work we do. We'll be using PHP for our examples.
In the second part of this series, we're going to take a look at how we can avoid writing code smells. Specifically, we'll be using PHP, a couple of tools, and WordPress as the environment of choice.
But first, let's have an introduction to code smells.
Depending on the type of developer you ask, you'll likely get a variation on the following definition:
Code smell, also known as a bad smell, in computer programming code, refers to any symptom in the source code of a program that possibly indicates a deeper problem.
This definition is straight from Wikipedia. It's not bad, but it's not my favorite take on the topic. Instead, my favorite definition comes from a prolific and popular programmer named Martin Fowler. You can read his entire take on the topic of code smells in this article, but I've distilled it down to the following points:
If you haven't read the article, he ends with this:
One of the nice things about smells is that it's easy for inexperienced people to spot them, even if they don't know enough to evaluate if there's a real problem or to correct them.
And I think that's a fantastic statement because it means this topic is positioned perfectly for those who are programmers but aren't sure where to start when it comes to identifying and addressing code smells.
In short, experience doesn't play a large role in this. Sure, those who are more experienced are likely to more easily identify smells (because they've seen more of them), but less experienced developers should be able to identify them.
Of course, when it comes to a topic like code smells, it's often easier to talk about them at an abstract level that it is to actually do something about them. But that's not practical, nor is it applicable to our day-to-day work.
With that said, why not take a look at some example of code smells? We'll examine why they are problematic and then offer a solution for how the smell could be removed by refactoring the code.
One of the easiest code smells to spot is when a programmer has opted to use unclear variable names. That is, in the context of the code, it's not clear as to what a given variable is supposed to represent.
Sure, there are times where this is acceptable (like using an i in a for loop). But in a longer method, it's not quite the same as for loop).
For example:
<?php
public function get_things( $x ) {
$l = array();
for ( $i = 0; $i < count( $x ); $i++ ) {
if ( true === $x[ $i ] ) {
array_push( $l, $x[ $i ] );
}
}
return $l;
}Given enough time, we'd likely be able to figure out what this is doing. First, it's a relatively simple method. Second, we'd be able to read through the variables, blocks, and return value to gain a better idea as to what's happening.
But if we're looking to write clean code that's easier to understand as we refer back to it or another programmer works with it, then using clear naming conventions always helps. And the above code does not use clear naming conventions.
Instead, let's refactor it so that it looks like this:
<?php
public function get_flagged_items( $items ) {
$flagged_items = array();
for ( $i = 0; $i < count( $items ); $i++ ) {
$current_item = $items[ $i ] ;
if ( true === $current_item ) {
array_push( $flagged_items, $current_item );
}
}
return $flagged_items;
}Much easier to understand, isn't it?
Notice that the algorithm itself hasn't changed, but the function name and the variable names have. This has made that much of a difference in reading this code. If asked what this code is supposed to be doing, we can easily say something like:
Returns an array of items marked as true from a predefined array of items.
As much as possible, avoid using generic variable names and use whatever is the clearest option for you and your peers.
In programming, you would be hard-pressed to find a developer who had not heard of KISS or DRY (you know, "don't repeat yourself"). Despite this, we often do repeat ourselves.
This is indicative of the fact that attempting to adhere to the DRY principles lands differently with different types of programmers. And that's fine! There is no single way to demonstrate how to adhere to this principle.
But because there are multiple ways to do so, we can provide an example of what it should not look like and what it should look like.
Assume for the purposes of the following example that we have a function called save_post and it accepts two arguments: a post ID and a string representing the title of the post. A code smell would look something like this:
<?php
public function save_posts() {
save_post( 1, 'Hello World!' );
save_post( 2, 'Goodbye World!' );
save_post( 3, 'What is this new world?' );
}
But why would we manually type out a call to save_post three times? Instead, let's set up an associative array, iterate through it, and then call the method once per iteration.
<?php
public function save_posts() {
$posts = [
1 => 'Hello World!',
2 => 'Goodbye World!',
3 => 'What is this new world?',
];
foreach ( $post as $post_id => $post_title ) {
save_post( $post_id, $post_title );
}
}Though calling the method once is nice, the method could be made even more flexible by having it accept the array of posts as an argument and leaving the foreach loop intact, though that's not really the point of this example.
If you find yourself making the same method call multiple times in a function but with different parameters, you may have a code smell. And if you do, then look for ways to refactor it so that you're calling the method only once.
After all, you don't want to repeat yourself.
One of the more common things that we continue to see in programming, regardless of the language, is when a function accepts a large number of parameters.
Different programmers will have opinions on what's the ideal number of parameters a function should accept, but I tend to think three (give or take two, maybe) is a good number.
First, let's take a look at what a function with a long parameter list would look like. There are likely no surprises in the following code, and you may be dealing with something exactly like this in one of your current projects:
<?php
public function submit_order( $first, $last, $address1, $address2, $city, $state, $zip, $phone, $cc, $expiration ) {
/* Attempt to submit the order. If the order is successful,
* then return an instance of an Order object with the success status;
* otherwise, return an instance of an Order object with the failed status
* and a message.
*/
}Notice in the above example we aren't concerned with the implementation of the function. Instead, we're concerned with how many parameters it requires. That's a lot of information to send, and it will make the method call that much uglier, as well.
It doesn't even hit on the topic of verification and validation. But I digress on that.
How could this one be cleaned up? Personally, I'm a fan of creating classes to represent collections of information like this. For this particular example, we could have a class that presents a person's contact information. Furthermore, that person could be associated with a credit card number.
The details of this could be enforced using business logic elsewhere in the application, but the abstraction would look something like this:
<?php
class Contact_Information {
/* Maintains attributes of the person's contact information. */
}
class Payment_Information {
/* Maintains the credit card number and other information for a person. */
}
class Order {
public function submit( $contact_info, $payment_info ) {
/* Attempt to submit the order. If the order is successful,
* then return an instance of an Order object with the success status;
* otherwise, return an instance of an Order object with the failed status
* and a message.
*/
}
}This refactoring, although small, is the largest we've done in this particular article. Notice that we've done the following things:
Contact_Information class that allows us to instantiate an object that includes all payment information for a person.Payment_Information class that allows us to maintain the credit card or debit card number for a person as well as other details associated with that payment method.Order class, placed the submit_order function inside of it, renamed it to submit (since submit_order would be redundant), and decreased its parameter list to two values: an instance of the Contact_Information class and the Payment_Information class).To be clear, this example does not handle the verification of association between contact information and payment information, nor does it show other classes that may be necessary (such as whether or not payment failed for the transaction).
But that's not the point of the exercise.
Instead, we're looking at the code smell of long parameter lists and how we can decrease them using practical, more maintainable methods available to us.
Whenever you're writing a function or making a call to a function that requires a large number of arguments, look for ways to refactor that function. It will make the cohesion of the code increase and the smell decrease.
Remember, the examples that we've looked at above are just that. The list is by no means complete, but they are common smells that you're likely to see in code with which you work or even code you write. I'll be the first to admit that I'm guilty of this.
Additionally, there are many, many resources that are available when it comes to identifying and fixing code smells. Luckily, we also have a number of tools at our disposal that will help us discover them automatically and clean them up.
And that's where we're headed next. Specifically, we're going to use PHP CodeSniffer in order to help us avoid code smells in our code. Then, we're going to see how to incorporate the WordPress rules into PHP CodeSniffer and hook it up to our IDE of choice.
As mentioned earlier in this article, the next article in the series will focus more on code smells when writing code for WordPress. We'll take a look at some tools and resources available to help make sure we're avoiding code smells, and to help make sure we're writing stronger code.
In the meantime, study the examples above and check out the resources that I've provided as they are great places to learn more about smells and code refactoring from people and places that are notable within our industry.
Remember, you can catch all of my courses and tutorials on my profile page, and you can follow me on my blog and/or Twitter at @tommcfarlin where I talk about various software development practices and how we can employ them in WordPress.
Please don't hesitate to leave any questions or comments in the feed below, and I'll aim to respond to each of them.
Create Modern Vue Apps Using Create-Vue and Vite
/
5Pros and Cons of Using WordPress
/
-4How to Fix the “There Has Been a Critical Error in Your Website” Error in WordPress
/
1How To Fix The “There Has Been A Critical Error in Your Website” Error in WordPress
How to Create a Privacy Policy Page in WordPress
/
8WordPress Website Maintenance Guide For Beginners
/
6How Long Does It Take to Learn JavaScript?
/
-1How Long Does it Take to Learn JavaScript
/
1The Best Way to Deep Copy an Object in JavaScript
/
-2
4
-5Adding and Removing Elements From Arrays in JavaScript
/
-2Create a JavaScript AJAX Post Request: With and Without jQuery
/
75 Real-Life Uses for the JavaScript reduce() Method
/
-9How to Enable or Disable a Button With [removed] jQuery vs. Vanilla
/
4How to Enable or Disable a Button With [removed] jQuery vs Vanilla
/
-4Confirm Yes or No With JavaScript
/
-1How to Change the URL in [removed] Redirecting
/
-315+ Best WordPress Twitter Widgets
/
-227 Best Tab and Accordion Widget Plugins for WordPress (Free & Premium)
/
1021 Best Tab and Accordion Widget Plugins for WordPress (Free & Premium)
/
-1130 HTML Best Practices for Beginners
/
-831 Best WordPress Calendar Plugins and Widgets (With 5 Free Plugins)
/
525 Ridiculously Impressive HTML5 Canvas Experiments
/
-7
1How to Implement Email Verification for New Members
/
3How to Create a Simple Web-Based Chat Application
/
530 Popular WordPress User Interface Elements
/
-5Top 18 Best Practices for Writing Super Readable Code
/
3Best Affiliate WooCommerce Plugins Compared
/
-1018 Best WordPress Star Rating Plugins
/
1410+ Best WordPress Twitter Widgets
/
420+ Best WordPress Booking and Reservation Plugins
/
5Working With Tables in React: Part Two
/
-4Best CSS Animations and Effects on CodeCanyon
/
-1630 CSS Best Practices for Beginners
/
4How to Create a Custom WordPress Plugin From Scratch
/
510 Best Responsive HTML5 Sliders for Images and Text… and 3 Free Options
/
-416 Best Tab and Accordion Widget Plugins for WordPress
/
-418 Best WordPress Membership Plugins and 5 Free Plugins
/
325 Best WooCommerce Plugins for Products, Pricing, Payments and More
/
310 Best WordPress Twitter Widgets
1 /
1512 Best Contact Form PHP Scripts for 2020
/
-320 Popular WordPress User Interface Elements
/
-210 Best WordPress Star Rating Plugins
/
-312 Best CSS Animations on CodeCanyon
/
112 Best WordPress Booking and Reservation Plugins
/
220 Best WordPress Calendar Plugins and Widgets
/
-212 Elegant CSS Pricing Tables for Your Latest Web Project
/
724 Best WordPress Form Plugins for 2020
/
-314 Best PHP Event Calendar and Booking Scripts
/
-1Create a Blog for Each Category or Department in Your WooCommerce Store
/
18 Best WordPress Booking and Reservation Plugins
/
-18Best Exit Popups for WordPress Compared
/
20Best Exit Popups for WordPress Compared
/
-611 Best Tab & Accordion WordPress Widgets & Plugins
/
-1012 Best Tab & Accordion WordPress Widgets & Plugins
1 /
1New Course: Practical React Fundamentals
/
3Short Course: Better Angular App Architecture With Modules
/
2Preview Our New Course on Angular Material
/
5Object-Oriented PHP With Classes and Objects
/
3Best Practices for ARIA Implementation
/
-2Accessible Apps: Barriers to Access and Getting Started With Accessibility
/
-3Dramatically Speed Up Your React Front-End App Using Lazy Loading
/
1915 Best Modern JavaScript Admin Templates for React, Angular, and Vue.js
/
-1515 Best Modern JavaScript Admin Templates for React, Angular and Vue.js
/
319 Best JavaScript Admin Templates for React, Angular, and Vue.js
/
3New Course: Build an App With JavaScript and the MEAN Stack
/
10Hands-on With ARIA: Accessibility Recipes for Web Apps
/
810 Best WordPress Facebook Widgets
13 /
-5Hands-on With ARIA: Accessibility for eCommerce
/
6New eBooks Available for Subscribers
/
-5Hands-on With ARIA: Homepage Elements and Standard Navigation
/
10
-9Site Accessibility: Getting Started With ARIA
/
4How Secure Are Your JavaScript Open-Source Dependencies?
/
-1New Course: Secure Your WordPress Site With SSL
/
-3Testing Components in React Using Jest and Enzyme
/
-8Testing Components in React Using Jest: The Basics
/
-415 Best PHP Event Calendar and Booking Scripts
/
-1Create Interactive Gradient Animations Using Granim.js
/
11How to Build Complex, Large-Scale Vue.js Apps With Vuex
1 /
1Examples of Dependency Injection in PHP With Symfony Components
/
-4Set Up Routing in PHP Applications Using the Symfony Routing Component
1 /
11A Beginner’s Guide to Regular Expressions in JavaScript
/
12Introduction to Popmotion: Custom Animation Scrubber
/
-4Introduction to Popmotion: Pointers and Physics
/
-10New Course: Connect to a Database With Laravel’s Eloquent ORM
/
-5How to Create a Custom Settings Panel in WooCommerce
/
-12Building the DOM faster: speculative parsing, async, defer and preload
1 /
120 Useful PHP Scripts Available on CodeCanyon
3 /
49How to Find and Fix Poor Page Load Times With Raygun
/
2Introduction to the Stimulus Framework
/
-14Single-Page React Applications With the React-Router and React-Transition-Group Modules
/
1
612 Best Contact Form PHP Scripts
1 /
-4Getting Started With the Mojs Animation Library: The ShapeSwirl and Stagger Modules
/
2Getting Started With the Mojs Animation Library: The Shape Module
/
-4Getting Started With the Mojs Animation Library: The HTML Module
/
4Project Management Considerations for Your WordPress Project
/
-98 Things That Make Jest the Best React Testing Framework
/
3Creating an Image Editor Using CamanJS: Layers, Blend Modes, and Events
/
-3New Short Course: Code a Front-End App With GraphQL and React
Creating an Image Editor Using CamanJS: Applying Basic Filters
/
-12Creating an Image Editor Using CamanJS: Creating Custom Filters and Blend Modes
/
1Challenge: Create a To-Do List in React
1 /
1Deploy PHP Web Applications Using Laravel Forge
/
-1Getting Started With the Mojs Animation Library: The Burst Module
/
5
-910 Things Men Can Do to Support Women in Tech
/
1A Gentle Introduction to Higher-Order Components in React: Best Practices
/
-4Challenge: Build a React Component
/
-4A Gentle Introduction to HOC in React: Learn by Example
/
5A Gentle Introduction to Higher-Order Components in React
/
-7Creating Pretty Popup Messages Using SweetAlert2
/
5Creating Stylish and Responsive Progress Bars Using ProgressBar.js
/
1718 Best Contact Form PHP Scripts for 2022
/
-3Creating a Blogging App Using Angular & MongoDB: Delete Post
/
-17Set Up an OAuth2 Server Using Passport in Laravel
/
1Creating a Blogging App Using Angular & MongoDB: Edit Post
/
-2Creating a Blogging App Using Angular & MongoDB: Add Post
/
-1Creating a Blogging App Using Angular & MongoDB: Show Post
/
8Creating a Blogging App Using Angular & MongoDB: Home
/
10
2Creating a Blogging App Using Angular & MongoDB: Login
/
13Creating Your First Angular App: Implement Routing
/
13Persisted WordPress Admin Notices: Part 4
/
-4Creating Your First Angular App: Components, Part 2
/
3Persisted WordPress Admin Notices: Part 3
/
3How Laravel Broadcasting Works
/
1
9Persisted WordPress Admin Notices: Part 2
/
-3Create Your First Angular App: Storing and Accessing Data
/
2Persisted WordPress Admin Notices: Part 1
/
-3Error and Performance Monitoring for Web & Mobile Apps Using Raygun
/
6Using Luxon for Date and Time in JavaScript
7 /
-5How to Create an Audio Oscillator With the Web Audio API
/
-6How to Cache Using Redis in Django Applications
/
220 Essential WordPress Utilities to Manage Your Site
/
-5Introduction to API Calls With React and Axios
/
18Beginner’s Guide to Angular 4: HTTP
/
11Rapid Web Deployment for Laravel With GitHub, Linode, and RunCloud.io
/
8Beginners Guide to Angular 4: Routing
/
-9Beginner’s Guide to Angular 4: Components
/
1Creating a Drop-Down Menu for Mobile Pages
/
3Introduction to Forms in Angular 4: Writing Custom Form Validators
/
510 Best WordPress Booking & Reservation Plugins
/
2Getting Started With Redux: Connecting Redux With React
/
15Getting Started With Redux: Learn by Example
/
16Getting Started With Redux: Why Redux?
/
9Understanding Recursion With JavaScript
/
-2How to Auto Update WordPress Salts
/
-8How to Download Files in Python
/
-3
-22Eloquent Mutators and Accessors in Laravel
1 /
17
-11
1210 Best HTML5 Sliders for Images and Text
/
5Site Authentication in Node.js: User Signup
/
-4Creating a Task Manager App Using Ionic: Part 2
/
2Creating a Task Manager App Using Ionic: Part 1
/
1
3Introduction to Forms in Angular 4: Template-Driven Forms
/
-124 Essential WordPress Utilities to Manage Your Site
/
-125 Essential WordPress Utilities to Manage Your Site
/
-12Get Rid of Bugs Quickly Using BugReplay
1 /
-14Manipulating HTML5 Canvas Using Konva: Part 1, Getting Started
/
710 Must-See Easy Digital Downloads Extensions for Your WordPress Site
22 Best WordPress Booking and Reservation Plugins
/
-5Understanding ExpressJS Routing
/
-515 Best WordPress Star Rating Plugins
/
12Inheritance and Extending Objects With JavaScript
/
-8Introduction to the CSS Grid Layout With Examples
1 /
2
8Performant Animations Using KUTE.js: Part 5, Easing Functions and Attributes
/
-8Performant Animations Using KUTE.js: Part 4, Animating Text
/
-12Performant Animations Using KUTE.js: Part 3, Animating SVG
/
-9New Course: Code a Quiz App With Vue.js
/
-1Performant Animations Using KUTE.js: Part 2, Animating CSS Properties
/
3
9Performant Animations Using KUTE.js: Part 1, Getting Started
/
410 Best Responsive HTML5 Sliders for Images and Text (Plus 3 Free Options)
/
-3Single-Page Applications With ngRoute and ngAnimate in AngularJS
/
-12Deferring Tasks in Laravel Using Queues
/
-5
4Site Authentication in Node.js: User Signup and Login
/
11Working With Tables in React, Part Two
/
-16Working With Tables in React, Part One
/
6How to Set Up a Scalable, E-Commerce-Ready WordPress Site Using ClusterCS
/
-2New Course on WordPress Conditional Tags
/
4
-11Building With Vue.js 2 and Firebase
6 /
10
-6
1Best Unique Bootstrap JavaScript Plugins
/
-10
-5Essential JavaScript Libraries and Frameworks You Should Know About
/
7
3Vue.js Crash Course: Create a Simple Blog Using Vue.js
/
-13Build a React App With a Laravel RESTful Back End: Part 1, Laravel 5.5 API
/
4API Authentication With Node.js
/
-4Beginner’s Guide to Angular: HTTP
/
7Beginner’s Guide to Angular: Routing
/
-4Beginners Guide to Angular: Routing
/
-6Beginner’s Guide to Angular: Services
/
5Beginner’s Guide to Angular: Components
/
-1How to Create a Custom Authentication Guard in Laravel
/
7Learn Computer Science With [removed] Part 3, Loops
/
-3Build Web Applications Using Node.js
/
2Learn Computer Science With [removed] Part 4, Functions
/
3Learn Computer Science With [removed] Part 2, Conditionals
/
12Learn Computer Science With [removed] Part 1, The Basics
/
-5Create Interactive Charts Using Plotly.js, Part 5: Pie and Gauge Charts
/
-8Create Interactive Charts Using Plotly.js, Part 4: Bubble and Dot Charts
/
18Create Interactive Charts Using Plotly.js, Part 3: Bar Charts
/
-14Awesome JavaScript Libraries and Frameworks You Should Know About
/
-4Create Interactive Charts Using Plotly.js, Part 2: Line Charts
/
-8Bulk Import a CSV File Into MongoDB Using Mongoose With Node.js
/
-4Build a To-Do API With Node, Express, and MongoDB
/
-6Getting Started With End-to-End Testing in Angular Using Protractor
/
10TypeScript for Beginners, Part 4: Classes
/
-10Object-Oriented Programming With JavaScript
/
610 Best Affiliate WooCommerce Plugins Compared
/
9Stateful vs. Stateless Functional Components in React
/
11Make Your JavaScript Code Robust With Flow
/
-6Build a To-Do API With Node and Restify
/
7Testing Components in Angular Using Jasmine: Part 2, Services
/
1Testing Components in Angular Using Jasmine: Part 1
/
-2Creating a Blogging App Using React, Part 6: Tags
/
-11React Crash Course for Beginners, Part 3
/
3React Crash Course for Beginners, Part 2
/
12React Crash Course for Beginners, Part 1
/
2Set Up a React Environment, Part 4
1 /
8Set Up a React Environment, Part 3
/
-11New Course: Get Started With Phoenix
/
-11Set Up a React Environment, Part 2
/
2Command Line Basics and Useful Tricks With the Terminal
/
3How to Create a Real-Time Feed Using Phoenix and React
/
-8Build a React App With a Laravel Back End: Part 2, React
/
2Build a React App With a Laravel RESTful Back End: Part 1, Laravel 9 API
/
-7Creating a Blogging App Using React, Part 5: Profile Page
/
-5Pagination in CodeIgniter: The Complete Guide
/
22JavaScript-Based Animations Using Anime.js, Part 4: Callbacks, Easings, and SVG
/
-1JavaScript-Based Animations Using Anime.js, Part 3: Values, Timeline, and Playback
Learn to Code With [removed] Part 1, The Basics
/
510 Elegant CSS Pricing Tables for Your Latest Web Project
/
-6Getting Started With the Flux Architecture in React
/
-2Getting Started With Matter.js: The Composites and Composite Modules
/
4Getting Started With Matter.js: The Engine and World Modules
/
1410 More Popular HTML5 Projects for You to Use and Study
/
-24Understand the Basics of Laravel Middleware
/
-6Iterating Fast With Django & Heroku
/
8Creating a Blogging App Using React, Part 4: Update & Delete Posts
/
3Creating a jQuery Plugin for Long Shadow Design
/
-9How to Register & Use Laravel Service Providers
2 /
-13Unit Testing in React: Shallow vs. Static Testing
/
5Creating a Blogging App Using React, Part 3: Add & Display Post
/
15Creating a Blogging App Using React, Part 2: User Sign-Up
20 /
-5Creating a Blogging App Using React, Part 1: User Sign-In
/
99 More Popular HTML5 Projects for You to Use and Study
/
18Creating a Grocery List Manager Using Angular, Part 2: Managing Items
/
99 Elegant CSS Pricing Tables for Your Latest Web Project
/
1Dynamic Page Templates in WordPress, Part 3
/
-2Angular vs. React: 7 Key Features Compared
/
6Creating a Grocery List Manager Using Angular, Part 1: Add & Display Items
/
2New eBooks Available for Subscribers in June 2017
/
7Create Interactive Charts Using Plotly.js, Part 1: Getting Started
/
11The 5 Best IDEs for WordPress Development (And Why)
/
233 Popular WordPress User Interface Elements
/
2New Course: How to Hack Your Own App
/
-10How to Install Yii on Windows or a Mac
/
5What Is a JavaScript Operator?
/
-5How to Register and Use Laravel Service Providers
/
8
waly Good blog post. I absolutely love this…