The document discusses several ways to write readable code, including using proper formatting and spacing, clear and consistent naming conventions, modular code structure, and refactoring techniques. It provides examples of good code formatting practices like adding spacing before returns, arranging variables consistently, using descriptive names instead of abbreviations, and prefixing variables and methods for clarity. The document emphasizes that readable code clearly communicates intent to readers.

2. Abbas Ali
Web Developer

3. “Readable code is code that
clearly communicates its intent to the reader”
Source: https://fellow.app/blog/engineering/the-complete-guide-to-readable-code/

4. What is good code?

5. What is good code?

6. Appearance

7. Formatting
Coding
Standards

8. Formatting
Coding
Standards
CS Fixer

9. Spacing
function handle_form_submission() {
$error = new WP_Error();
if ( empty( $_POST['first_name'] ) ) {
$error->add( 'empty', 'First name is required' );
}
if ( empty( $_POST['last_name'] ) ) {
$error->add( 'empty', 'Last name is required' );
}
// ...
}

10. Spacing
function handle_form_submission() {
$error = new WP_Error();
if ( empty( $_POST['first_name'] ) ) {
$error->add( 'empty', 'First name is required' );
}
if ( empty( $_POST['last_name'] ) ) {
$error->add( 'empty', 'Last name is required' );
}
// ...
}

11. Spacing before return
function get_user( $id ) {
$data = WP_User::get_data_by( 'ID', $id );
$user = new WP_User;
$user->init( $data );
return $user;
}

12. Spacing before return
function get_user( $id ) {
$data = WP_User::get_data_by( 'ID', $id );
$user = new WP_User;
$user->init( $data );
return $user;
}

13. Return early
function make_editor( $id ) {
$userdata = WP_User::get_data_by( 'ID', $id );
if ( $userdata ) {
$user = new WP_User;
$user->init( $userdata );
$user->add_role( 'editor' );
return $user;
} else {
return false;
}
}

14. Return early
function make_editor( $id ) {
$userdata = WP_User::get_data_by( 'ID', $id );
if ( !$userdata ) {
return false;
}
$user = new WP_User;
$user->init( $userdata );
$user->add_role( 'editor' );
return $user;
}

15. Arrange variables
$start_day = 2;
$start_year = 2022;
$end_day = 3;
$start_month = 4;
$end_year = 2023;
$end_month = 6;

16. Arrange variables
$start_day = 2;
$start_month = 4;
$start_year = 2022;
$end_day = 3;
$end_month = 6;
$end_year = 2023;

17. Nomenclature

18. only two hard things in Computer Science: cache invalidation and nam
— Phil Karlton

19. Why naming matters?
• Naming is communication and bad naming prevents code from
communicating clearly.
• Code with obfuscated names is hard to read and understand.
• Other people should be able to read and understand the code.

21. Use proper language
Source: https://www.learningexplorer.org

22. Use proper language
Source: https://unsplash.com/

23. Use proper language

24. Avoid abbreviations
function calculate_salary() {
$b = 10000;
$hra = 5000;
$ta = 3000;
$inc = 5000;
$tds = 2000;
$sal = ($b + $hra + $ta + $inc) - $tds;
return $sal;
}

25. Avoid abbreviations
function calculate_salary() {
$basic = 10000;
$hra = 5000;
$travel_allowance = 3000;
$incentive = 5000;
$tds = 2000;
$salary = ($basic + $hra + $travel_allowance + $incentive) - $tds;
return $salary;
}

26. Prefix variables and methods
function handle( $id ) {
$todo = get_todo( $id );
$completed = $todo->completed();
if ( $completed ) {
// do something
}
}

27. Prefix variables and methods
function handle( $id ) {
$todo = get_todo( $id );
$is_completed = $todo->is_completed();
if ( $is_completed ) {
// do something
}
}

28. Function prefixes
$user = find_user( $id );
$remote_user = find_remote_user( $id );

29. Function prefixes
$user = get_user( $id );
$remote_user = fetch_user( $id );

30. Consistency in naming
function handle()
{
$first_name = 'John';
$lastName = 'Doe';
$EmailAddress = 'john@doe.com';
}

31. Consistency in naming
function handle()
{
$first_name = 'John';
$last_name = 'Doe';
$email_address = 'john@doe.com';
}

32. Use timestamps instead of booleans
$todo = get_todo( $id );
if ( $todo['completed'] === true ) {
// When was it completed?
}

33. Use timestamps instead of booleans
$todo = get_todo( $id );
if ( $todo[‘completed_at'] !== null ) {
// We now know when it was completed
}

34. Code Format and Refactor

35. Only if there was no else!
function send_email() {
if ( $user->is_active() ) {
if ( $user->has_subscribed() ) {
return send_subscription_email( $user );
} else {
return send_marketing_email( $user );
}
} else {
return send_activation_email( $user );
}
}

36. Only if there was no else!
function send_email() {
if ( !$user->is_active() ) {
return send_activation_email( $user );
}
if ( $user->hasSubscribed() ) {
return send_subscription_email( $user );
}
return send_marketing_email( $user );
}

37. Methods ordering
class My_Class {
public function update();
public function destroy();
public function create();
}

38. Methods ordering
class My_Class {
public function create();
public function update();
public function destroy();
}

39. Refactor your code
function subscribe() {
if (
( $user->is_active === true && $user->deleted_at !== null )
|| $user->is_admin === true
) {
$user->start_subscription();
}
}

40. Refactor your code
function subscribe() {
if ( $user->can_subscribe() ) {
$user->start_subscription();
}
}

41. Modular code
function save() {
global $wpdb;
// get and save invoices
$response = wp_remote_get( 'https://dummyjson.com/products' );
if( is_wp_error( $response ) ) {
return false;
}
$body = wp_remote_retrieve_body( $response );
$products = json_decode( $body, true );
foreach ( $products as $product ) {
$wpdb->insert( 'wp_products', ['name' => $product['title'], 'price' => $product['price']] );
$product_id = $wpdb->insert_id;
foreach ( $product['images'] as $image ) {
$upload_dir = wp_upload_dir();
$path = $upload_dir . '/products/' . md5( $image ) . '.jpg';
$wpdb->insert( 'wp_product_images', ['product_id' => $product_id, 'path' => $path] );
file_put_contents( $path, file_get_contents($image) );
}
}
}

42. Modular code
function fetch_products() {
// get and save invoices
$response = wp_remote_get( 'https://dummyjson.com/products' );
if( is_wp_error( $response ) ) {
return false;
}
$body = wp_remote_retrieve_body( $response );
return json_decode( $body, true );
}

43. Modular code
function save_products( $products ) {
global $wpdb;
foreach ( $products as $product ) {
$fields = ['name' => $product['title'], 'price' => $product['price']];
$wpdb->insert( 'wp_products', $fields );
save_product_images( $wpdb->insert_id, $product['images'] );
}
}

44. Modular code
function save_product_images( $product_id, $images ) {
global $wpdb;
foreach ( $images as $image ) {
$upload_dir = wp_upload_dir();
$path = $upload_dir . '/products/' . md5( $image ) . '.jpg';
$wpdb->insert( 'wp_product_images', ['product_id' => $product_id, 'pat
file_put_contents( $path, file_get_contents($image) );
}
}

45. Modular code
function save() {
if ( !$products = fetch_products() ) {
return false;
}
save_products( $products );
}

46. Smart variable assignment
function my_function() {
$user = get_user( $id );
if ( !$user ) {
return false;
}
$user->some_method();
}

47. Smart variable assignment
function my_function() {
if ( !$user = get_user( $id ) ) {
return false;
}
$user->some_method();
}

48. Thank You!
Abbas Ali
Ranium Systems
@_abbas
abbasali

49. Caption

50. Caption

51. Caption
https://laravelnagpur.com

52. Questions?
Getty Images