Half-Elf on Tech

Thoughts From a Professional Lesbian

Tag: wp-cli

  • It’s Just Math: WP-CLI Edition

    It’s Just Math: WP-CLI Edition

    Remember how I talked about doing math on a post when it was saved?

    Well what if I wanted to run that at another time? Like what if I knew I needed to update one show and I didn’t want to go in and save the post?

    I can to this with WP-CLI:

    WP CLI Magic

    class WP_CLI_MySite_Commands extends WP_CLI_Command {
	/**
	 * Re-run calculations for specific post content.
	 * 
	 * ## EXAMPLES
	 * 
	 *		wp mysite calc actor ID
	 *		wp mysite calc show ID
	 *
	*/
	
	function calc( $args , $assoc_args ) {

		// Valid things to calculate:
		$valid_calcs = array( 'actor', 'show' );
		
		// Defaults
		$format = ( isset( $assoc_args['format'] ) )? $assoc_args['format'] : 'table';

		// Check for valid arguments and post types
		if ( empty( $args ) || !in_array( $args[0], $valid_calcs ) ) {
			WP_CLI::error( 'You must provide a valid type of calculation to run: ' . implode( ', ', $valid_calcs ) );
		}

		// Check for valid IDs
		if( empty( $args[1] ) || !is_numeric( $args[1] ) ) {
			WP_CLI::error( 'You must provide a valid post ID to calculate.' );
		}

		// Set the post IDs:
		$post_calc = sanitize_text_field( $args[0] );
		$post_id   = (int)$args[1];

		// Last sanitity check: Is the post ID a member of THIS post type...
		if ( get_post_type( $post_id ) !== 'post_type_' . $post_calc . 's' ) {
			WP_CLI::error( 'You can only calculate ' . $post_type . 's on ' . $post_type . ' pages.' );
		}

		// Do the thing!
		// i.e. run the calculations
		switch( $post_calc ) {
			case 'show':
				// Rerun show calculations
				MySite_Show_Calculate::do_the_math( $post_id );
				$score = 'Score: ' . get_post_meta( $post_id, 'shows_the_score', true );
				break;
			case 'actor':
				// Recount characters and flag queerness
				MySite_Actor_Calculate::do_the_math( $post_id );
				$queer = ( get_post_meta( $post_id, 'actors_queer', true ) )? 'Yes' : 'No';
				$chars = get_post_meta( $post_id, 'actors_char_count', true );
				$deads = get_post_meta( $post_id, 'actors_dead_count', true );
				$score = ': Is Queer (' . $queer . ') Chars (' . $chars . ') Dead (' . $deads . ')';
				break;
		}

		WP_CLI::success( 'Calculations run for ' . get_the_title( $post_id ) . $score );
	}
}

    What the What?

    The one for shows is a lot simpler. I literally call that do_the_math() function with the post ID and I get back a number. Then I output the number and I’m done. If I wanted it to run for all shows, I could use WP-CLI to spit out a list of all the IDs and then pass them to the command one at a time. Or I could write one that does ‘all’ posts. Which I may

    But the point is that I now can type wp mysite calc show 1234 and if post ID 1234 is a show, it’ll run.

  • WP-CLI Tables

    WP-CLI Tables

    I was working on an update to the Varnish plugin I’ve adopted, and one of the requested features was for more debugging tool. I’d added in a status page, but this plugin is also used by web hosts, and sometimes asking a customer “Can you go to this bad and send me the results?” is a time sink.

    So why not add in a command line tool?

    WP-CLI?

    I love WP-CLI. It’s a command line interface (CLI) for WordPress (WP) that lets you do most anything via the command line. You can install and activate plugins, update themes, even write posts and add users. But if you’re tech savvy, it’s also a great tool to automate and manage the minutia of WordPress maintenance drudgery.

    I’d already built out a basic varnish flush command (wp varnish purge) so adding on to it isn’t terribly difficult. But what was difficult was making the output what I wanted.

    Start With an Array

    No matter what you need an array of the correct format for this to work. I was already storing everything in an array I save in a variable called $results that looks like this:

    Array ( 
    [varnish] => Array ( 
        [icon] => awesome 
        [message] => Varnish is running properly and caching is happening. 
    ) 
    [remote_ip] => Array ( 
        [icon] => awesome 
        [message] => Your server IP setup looks good. 
    ) 
    [age] => Array ( 
        [icon] => good 
        [message] => Your site is returning proper "Age" headers. 
    )
)

    I was initially doing this so I could loop and output all results with an icon and message on the status page, but translating this to wp-cli was a matter of taking the array and repurposing it.

    WP-CLI Tables

    In order to add in a table output to WP-CLI, you use the format_items function:

    WP_CLI\Utils\format_items( $format, $items, $headers );

    The $format value is taken from $assoc_args['format'] (I set mine to default to table if it’s not defined). The $items are your array, and the $headers are another array of what your headers are.

    This is the tricky part. You have to make sure your array of headers matches your array of items, and fulfills the output you desire. In order to do this, start with figuring out what you need to output.

    In my case, I wanted a name, a status (aka the icon), and the message. This means my array looks like this: $headers = array( 'name', 'status', 'message' )

    Rebuild The Array

    Once I sorted out what the format was like, based on the headers, I built the items array as follows:

    // Generate array
foreach ( $results as $type => $content ) { 
	$items[] = array(
		'name'    => $type,
		'status'  => ucwords( $content['icon'] ),
		'message' => $content['message'],
	);
}

    Remember, my $results were already an array. I’m just making it look right here.

    Final Results

    How does it look? Like this:

    +-----------+---------+-------------------------------------------------------+
| name      | status  | message                                               |
+-----------+---------+-------------------------------------------------------+
| varnish   | Awesome | Varnish is running properly and caching is happening. |
| remote_ip | Awesome | Your server IP setup looks good.                      |
| age       | Good    | Your site is returning proper "Age" headers.          |
+-----------+---------+-------------------------------------------------------+

    And that is a nice tool for people to debug.