/wordpress-coding-challenge

Primary LanguagePHPGNU General Public License v2.0GPL-2.0

WordPress Coding Challenge - Site Counts

CI/CD Pipeline Coverage Status

Instructions

This exercise tests your knowledge of security and performance in WordPress sites. The expectation is that you spend approximately one hour on this task. If you have not had the chance to work on large-scale projects or products you may be interested in brushing up on our Engineering Best Practices. You may also find the WordPress VIP documentation useful.

To begin, please fork this repo https://github.com/xwp-hiring/coding-challenge into your GitHub account as a public repository.

For this exercise we only want you to look at the XWP\SiteCounts\Block::render_callback() function and fix whatever problems you see, and make improvements as needed to solve scaling, security, performance, and coding standards issues. We follow the WordPress VIP coding standards which are additive to the core WordPress standards. There's no need to add any feature at this stage.

Please only make changes to the render_callback() function, and ignore the PHPUnit tests for now. When you're done, open a PR to the develop branch of your fork with your improvements. To complete the exercise, reply to the email you received with a link to the repository.

Description

A WordPress block showing counts of posts and taxonomies.

To test, add this 'Site Counts' block in the block editor.

Requirements

  • WordPress 5.6+.
  • PHP 7.3 or later, Composer and Node.js for dependency management.

We suggest using a software package manager for installing the development dependencies such as Homebrew on MacOS:

brew install php composer node

or Chocolatey for Windows:

choco install php composer node nodejs

Development

  1. Clone the plugin repository.

  2. Set up the development environment and tools using Node.js and Composer:

     npm install

    Note that both Node.js and PHP 7.3 or later are required on your computer for running the npm scripts.

Scripts

We use npm as the canonical task runner for the project. Some of the PHP related scripts are defined in composer.json.

  • npm run build to build the plugin JavaScript file. Use npm run dev to watch and re-build as you work.

  • npm run lint to lint both PHP and JS files. Use npm run lint:js and npm run lint:php to lint JS and PHP separately.

  • npm run test to run both PHP and JS tests without coverage reporting. Use npm run test:js and npm run test:php to run tests for JS and PHP seperately.

  • npm run test:coverage to run both PHP and JS tests with coverage reporting.

Continuous Integration

We use GitHub Actions to lint all code, run tests and report test coverage to Coveralls as defined in ci.yaml.