This is a WordPress plugin which contains a Gutenberg block. The block allows for embedding a video in a WordPress post or page. If the user who views the page is in China, a different video will show from users in the rest of the world. This is to appropriately deal with China's Internet wall which blocks YouTube and other video platforms.
This repo ships with its own wp-env ready to fire up a local development environment.
Make sure you have node installed. Go to command line and check your version to confirm. We recommend nodejs 20.16.0.
node -v
Install wp-env package as a global node package.
npm -g i @wordpress/env
The -g flag means global so you can then run wp-env commands from anywhere on your system.
After installation, at your command line check your version to confirm.
wp-env --version
Go to your working directory where the plugin code lives. Then start the env:
wp-env start
If changing the wp-env.json file or encountering problems, run:
wp-env start --update
You can also run the start command again for the environment to reload:
wp-env start
If you want to get more details about what the wp-env command is doing, add --debug after the command, i.e.
wp-env start --debug
To install npm packages:
npm install
To start development:
npm start
This will compile and run the block in development mode. Watches for any changes and reports back any errors in your code.
To build your code:
npm run build
Use to build production code for your block inside build folder. Runs once. Run this before releasing a new version.
You also have access to other wp-scripts commands, run npm run to see them.
To install composer packages:
wp-env run cli --env-cwd=wp-content/plugins/china-video-block composer install
Once installed, you can then multiple commands. To run sniffs:
wp-env run cli --env-cwd=wp-content/plugins/china-video-block composer run-script sniff
To fix sniffs:
wp-env run cli --env-cwd=wp-content/plugins/china-video-block composer run-script fix
To check PHP Compatibility:
wp-env run cli --env-cwd=wp-content/plugins/china-video-block composer run-script version-checks
You can run WP-CLI commands by prefixing the wp command like so:
wp-env run cli wp
To login to the WordPress, use:
localhost:8828/wp-admin
Username: admin Password: password
Don't upgrade plugins and WordPress core inside WordPress, make any updates in the .wp-env.json file and then run wp env start or wp-env start --update. This will download and install the updates.