Adds linting. Finalizes source'd files. Replaces shebang.

Author: JasonRaveling

.gitignore

@@ -1,2 +1,3 @@
 .watchsyncrc*
 watch-sync.sh
+config.sh

.shellcheckrc

@@ -0,0 +1 @@
+external-sources=true

README.md

@@ -2,4 +2,4 @@
 This is a collection of miscellaneous scripts that utilize [WP-CLI](https://wp-cli.org/), the command line interface for WordPress.
 
 # Usage
-Clone this repo and configure the path in `source/configs.sh`. Make the scripts executable as needed (i.e. `chmod +x wpcli-scripts/*.sh`).
+Clone this repo and configure the path in `source/config.sh`. Make the scripts executable as needed (i.e. `chmod +x wpcli-scripts/*.sh`).

count-plugin.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/env bash
 
 # Set the exact slug of the plugin you want to check
 plugin_slug='classic-editor';

count-themes.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/env bash
 
 # This script audits all sites in a WordPress Multisite network and provides a count and percentage
 # for every active theme.

delete-transient-every-network-site.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/env bash
 
 # Loop through each network site and delete a transient.
 #

delete-user.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/env bash
 
 # This interactive script deletes a given user by their ID and reattributes their content to another
 # user based on the provided ID.

empty-site-all.sh

@@ -1,9 +1,11 @@
-#!/bin/bash
+#!/bin/env bash
 
 # A script for emptying each network site and leaving just the network structure.
 #
 # DO NOT RUN THIS AS ROOT since some commands could potentially delete unwanted data if run as root.
 
+source 'source/includes.sh';
+
 # Script version
 version='1.0.3';
 
@@ -12,7 +14,7 @@ version='1.0.3';
 production_dir='www';
 
 # The theme name/slug to activate.
-theme_to_use='my-theme-name';
+theme_to_use='some-theme';
 
 # Gravity forms license key. Leave empty if you do not use it.
 gf_license_key=""
@@ -26,7 +28,7 @@ if [[ $current_dir =~ "$production_dir" ]]; then
 fi
 
 # Make sure that WP-CLI is installed.
-if [[ "$(which wp 2>/dev/null)" == "" ]]; then
+if [[ "$(which wp_skip_all 2>/dev/null)" == "" ]]; then
 	echo
 	echo "The WP-CLI command line interface could not be found. It is required for this script to run."
 	echo
@@ -52,13 +54,13 @@ echo
 read -r -p "Continue? [y/N] " user_consent
 echo
 
-# Pause before continuing to be sure the user understands this is desructive.
+# Pause before continuing to be sure the user understands this is destructive.
 case $user_consent in
 	[yY])
 		echo "You have agreed to destroy the entire site. Continuing."
 	;;
 	*)
-		echo "You have chosen not to contiune. Exiting."
+		echo "You have chosen not to continue. Exiting."
 		exit;
 	;;
 esac
@@ -71,7 +73,7 @@ esac
 
 echo $SECONDS > /dev/null # start the timer
 echo
-wp maintenance-mode activate
+wp_skip_all maintenance-mode activate
 
 # Site options to retain when wiping a site.
 site_options_to_retain=(
@@ -82,7 +84,7 @@ site_options_to_retain=(
 	"admin_email"
 );
 
-# Build the string of --exclude args for `wp option list`
+# Build the string of --exclude args for `wp_skip_all option list`
 site_options_exclude_regex=$(printf "^%s$|" "${site_options_to_retain[@]}")
 site_options_exclude_regex=${site_options_exclude_regex::-1} # remove the last pipe
 
@@ -91,7 +93,7 @@ site_options_exclude_regex=${site_options_exclude_regex::-1} # remove the last p
 # Destroy on a network level.
 ###################################################################################################
 echo
-echo "Starting sitewide destruction..."
+echo "Starting multisite destruction..."
 echo
 
 ###################################################################################################
@@ -102,37 +104,31 @@ echo "Destroying and removing archived and deleted sites."
 
 delete_site() {
 
-	site_id=$(wp site list | awk -v site_url=$site_url '{ if( $2 == site_url ) print $1; }')
+	site_id=$(wp_skip_all site list | awk -v site_url=$site_url '{ if( $2 == site_url ) print $1; }')
 
 	echo "Wiping site ID: ${site_id}"
 
-	wp site delete --yes --skip-themes $site_id
+	wp_skip_all site delete --yes --skip-themes $site_id
 }
 
-for site_url in $(wp site list --deleted=1 --field=url); do
+for site_url in $(wp_skip_all site list --deleted=1 --field=url); do
 	echo "DELETED site found: ${site_url}"
 	delete_site;
 done;
 
-for site_url in $(wp site list --archived=1 --field=url); do
+for site_url in $(wp_skip_all site list --archived=1 --field=url); do
 	echo "ARCHIVED site found: ${site_url}"
 	delete_site;
 done;
 
-for site_url in $(wp site list --spam=1 --field=url); do
+for site_url in $(wp_skip_all site list --spam=1 --field=url); do
 	echo "SPAM site found: ${site_url}"
 	delete_site;
 done;
 
-
-# wp-cli with extra flags and targeting one site.
-wp_on_site () {
-	wp --skip-themes --url="${site_url}" "$@"
-}
-
 echo
 echo 'Emptying active sites.'
-for site_url in $(wp site list --deleted=0 --archived=0 --spam=0 --field=url); do
+for site_url in $(wp_skip_all site list --deleted=0 --archived=0 --spam=0 --field=url); do
 
 	# Get the site nice name.
 	blogname=$(wp_on_site option get blogname)
@@ -208,40 +204,40 @@ rm -rf "${current_dir}/wp-content/uploads/*" 2>/dev/null
 wp_on_site transient delete --all
 
 # Disable caching
-wp update option wp_cache_enabled "0"
+wp_skip_all update option wp_cache_enabled "0"
 
 # For some reason network meta also gets changed. ms_files_rewrite
 # should be set to 0 otherwise WP reverts back to uploads file
 # structure from WP versions pre-3.5.
-wp network meta set 1 ms_files_rewriting 0
+wp_skip_all network meta set 1 ms_files_rewriting 0
 
-wp network meta set 1 subdomain_install 0 # We are using sub dirs
-wp network meta set 1 global_terms_enabled 0
+wp_skip_all network meta set 1 subdomain_install 0 # We are using sub dirs
+wp_skip_all network meta set 1 global_terms_enabled 0
 
 # wp_rg_* are deprecated tables https://docs.gravityforms.com/deprecated-database-tables/
-for table in $(wp db tables wp_gf_* wp_*_gf_* wp_rg_* wp_*_rg_* --all-tables); do
+for table in $(wp_skip_all db tables wp_gf_* wp_*_gf_* wp_rg_* wp_*_rg_* --all-tables); do
 	# Create a comma separated list of tables to be dropped for a MySQL qeury
 	tables_to_remove_sql="${tables_to_remove_sql}, ${table}"
 done;
 
 tables_to_remove_sql=${tables_to_remove_sql:2} # remove the first two chars (, )
 
 # Install and activate Gravity Forms.
-wp plugin deactivate gravityforms --network
-wp plugin uninstall gravityforms
+wp_skip_all plugin deactivate gravityforms --network
+wp_skip_all plugin uninstall gravityforms
 echo "Deleting tables created by Gravity Forms."
-wp db query "DROP TABLE IF EXISTS ${tables_to_remove_sql}"
-wp maintenance-mode deactivate
+wp_skip_all db query "DROP TABLE IF EXISTS ${tables_to_remove_sql}"
+wp_skip_all maintenance-mode deactivate
 
 # Check if a Gravity Forms license key was provided.
 if [[ -n "$gf_license_key" ]]; then
-	wp plugin install gravityforms
-	wp plugin install gravityformscli --activate-network || echo -e "\e[1;31mFailed to install Gravity Forms CLI.\e[0m"
-	wp gf install --skip-themes --key="${gf_license_key}" --activate-network
-	wp gf setup --skip-themes --force
+	wp_skip_all plugin install gravityforms
+	wp_skip_all plugin install gravityformscli --activate-network || echo -e "\e[1;31mFailed to install Gravity Forms CLI.\e[0m"
+	wp_skip_all gf install --skip-themes --key="${gf_license_key}" --activate-network
+	wp_skip_all gf setup --skip-themes --force
 fi
 
-home_page_url=$(wp site list --field="url" | head -n 1)
+home_page_url=$(wp_skip_all site list --field="url" | head -n 1)
 echo "Running wp-cron.php for the first time. (${home_page_url}wp-cron.php)"
 curl -s "${home_page_url}wp-cron.php" -o /dev/null
 

empty-site-single.sh

@@ -1,11 +1,13 @@
-#!/bin/bash
+#!/bin/env bash
 #
 # A script for emptying an individual network site and leaving an empty site.
 #
 # NOTE: Some PHP scripts may not like to be loaded via the command line. In some cases you can
 # check if 'cli' === php_sapi_name() and return out of a function. If you see any PHP errors while
 # running this script, you may want to start there.
 
+source 'source/includes.sh';
+
 # Script version
 version='1.0.3';
 
@@ -30,21 +32,11 @@ if [[ $current_dir =~ "$production_dir" ]]; then
 	echo
 fi
 
-# Make sure that WP-CLI is installed.
-if [[ "$(which wp 2>/dev/null)" == "" ]]; then
-	echo
-	echo "The WP-CLI command line interface could not be found. It is required for this script to run."
-	echo
-	echo "Visit https://wp-cli.org/ to get WP-CLI."
-	echo
-	exit
-fi
-
 while [[ -z $site_id ]]; do
 	read -p "Please provide the Site ID: " site_id;
 done;
 
-site_url="$(wp db query "SELECT option_value FROM wp_${site_id}_options WHERE option_name = 'siteurl'" --skip-themes --skip-plugins --allow-root --skip-column-names)";
+site_url="$(wp_skip_all db query "SELECT option_value FROM wp_${site_id}_options WHERE option_name = 'siteurl'" --skip-column-names)";
 site_url="${site_url}/";
 
 if [[ -z $site_url ]]; then
@@ -110,13 +102,13 @@ site_options_exclude_regex=${site_options_exclude_regex::-1} # remove the last p
 # Destroy the individual site.
 ###################################################################################################
 
-wp --allow-root maintenance-mode activate
+wp_skip_all maintenance-mode activate
 
 echo "Destroying site ID: ${site_id}"
 
-# wp-cli with extra flags and targetting one site.
+# wp-cli with extra flags and targeting one site.
 wp_on_site () {
-	wp --allow-root --url="${site_url}" "$@"
+	wp_skip_all --url="${site_url}" "$@"
 }
 
 echo
@@ -193,10 +185,10 @@ wp_on_site rewrite structure '/%year%/%monthnum%/%day%/%postname%/'
 # Final Cleanup
 ###################################################################################################
 
-wp --allow-root maintenance-mode deactivate
+wp_skip_all maintenance-mode deactivate
 
 # Run wp-cron now that all of these changes were made.
-home_page_url=$(wp site list --allow-root --field="url" | head -n 1)
+home_page_url=$(wp_skip_all site list --field="url" | head -n 1)
 echo "Running wp-cron.php for the first time. (${home_page_url}wp-cron.php)"
 curl -s "${home_page_url}wp-cron.php" -o /dev/null
 

plugin-activate-based-on-theme.sh

@@ -1,30 +1,35 @@
-#!/bin/sh
+#!/bin/env bash
 
-# Activates or deactivates a plugin based on the currently installed theme.
+# Activates or deactivates a plugin based on the currently activated theme.
 
+source 'source/includes.sh';
+
+# The plugin slug to activate.
+plugin='classic-editor';
+
+# The theme to check for when activating the plugin.
 theme='some-theme';
-plugin='a-plugin';
 
-wp plugin deactivate --network $plugin;
+wp_skip_all plugin deactivate --network $plugin;
 
 # Get every network site.
-for s in $(wp site list --field=url); do
+for s in $(wp_skip_all site list --field=url); do
 
 	echo;
 
 	# Run the command but we really want the return status: $?
-	wp theme is-active $theme --url="$s";
+	wp_skip_all theme is-active $theme --url="$s";
 	theme_is_not_active=$?;
 	echo "Site: $s";
 
 	if [[ 1 -eq $theme_is_not_active ]]; then
 		echo "$theme is NOT active.";
 		echo "Activating $plugin plugin...";
-		wp plugin activate $plugin --url="$s";
+		wp_skip_all plugin activate $plugin --url="$s";
 	else
 		echo "$theme is active. Skipping plugin activation.";
 		echo "Deactivating $plugin plugin...";
-		wp plugin deactivate $plugin --url="$s";
+		wp_skip_all plugin deactivate $plugin --url="$s";
 	fi;
 
 done;