SD_Hello_World

Complexity

Total Complexity

3

Size/Duplication

Total Lines	91
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	output()	0	16	2
A	__construct()	0	55	1

<?php

class SD_Hello_World extends WP_Super_Duper {


	public $arguments;

	/**
	 * Sets up the widgets name etc
	 */
	public function __construct() {

		$options = array(
			'textdomain'     => 'super-duper',
			// textdomain of the plugin/theme (used to prefix the Gutenberg block)
			'block-icon'     => 'fas fa-globe-americas',
			// Dash icon name for the block: https://developer.wordpress.org/resource/dashicons/#arrow-right
			// OR font-awesome 5 class name: fas fa-globe-americas
			'block-category' => 'widgets',
			// the category for the block, 'common', 'formatting', 'layout', 'widgets', 'embed'.
			'block-keywords' => "['hello','world']",
			// used in the block search, MAX 3
			'block-output'   => array( // the block visual output elements as an array
				array(
					'element' => 'p',
					'title'   => __( 'Placeholder', 'hello-world' ),
					'class'   => '[%className%]',
					'content' => 'Hello: [%after_text%]' // block properties can be added by wrapping them in [%name%]
				)
			),
			'block-wrap'    => '', // You can specify the type of element to wrap the block `div` or `span` etc.. Or blank for no wrap at all.
			'class_name'     => __CLASS__,
			// The calling class name
			'base_id'        => 'hello_world',
			// this is used as the widget id and the shortcode id.
			'name'           => __( 'Hello World', 'hello-world' ),
			// the name of the widget/block
			'widget_ops'     => array(
				'classname'   => 'hello-world-class',
				// widget class
				'description' => esc_html__( 'This is an example that will take a text parameter and output it after `Hello:`.', 'hello-world' ),
				// widget description
			),
			'no_wrap'       => true, // This will prevent the widget being wrapped in the containing widget class div.
			'arguments'      => array( // these are the arguments that will be used in the widget, shortcode and block settings.
				'after_text' => array( // this is the input name=''
					'title'       => __( 'Text after hello:', 'hello-world' ),
					// input title
					'desc'        => __( 'This is the text that will appear after `Hello:`.', 'hello-world' ),
					// input description
					'type'        => 'text',
					// the type of input, test, select, checkbox etc.
					'placeholder' => 'World',
					// the input placeholder text.
					'desc_tip'    => true,
					// if the input should show the widget description text as a tooltip.
					'default'     => 'World',
					// the input default value.
					'advanced'    => false
					// not yet implemented
				),
			)
		);

		parent::__construct( $options );
	}


	/**
	 * This is the output function for the widget, shortcode and block (front end).
	 *
	 * @param array $args The arguments values.
	 * @param array $widget_args The widget arguments when used.
	 * @param string $content The shortcode content argument
	 *
	 * @return string
	 */
	public function output( $args = array(), $widget_args = array(), $content = '' ) {

		/**
		 * @var string $after_text
		 * @var string $another_input This is added by filter below.
		 */
		extract( $args, EXTR_SKIP );

		/*
		 * This value is added by filter so might not exist if filter is removed so we check.
		 */
		if ( ! isset( $another_input ) ) {
			$another_input = '';
		}

		return "Hello: " . $after_text . "" . $another_input;

	}

}

// register it.
add_action( 'widgets_init', function () {
	register_widget( 'SD_Hello_World' );
} );


/**
 * Extend the options via filter hook, this can be done via plugin/theme.
 *
 * @param $options
 *
 * @return mixed
 */
function _my_extra_arguments( $options ) {

	/*
	 * Add a new input option.
	 */
	$options['arguments']['another_input'] = array(
		'name'        => 'another_input', // this is the input name=''
		'title'       => __( 'Another input:', 'hello-world' ), // input title
		'desc'        => __( 'This is an input added via filter.', 'hello-world' ), // input description
		'type'        => 'text', // the type of input, test, select, checkbox etc.
		'placeholder' => 'Placeholder text', // the input placeholder text.
		'desc_tip'    => true, // if the input should show the widget description text as a tooltip.
		'default'     => '', // the input default value.
		'advanced'    => false // not yet implemented
	);

	/*
	 * Output the new option in the block output also.
	 */
	$options['block-output']['element::p']['content'] = $options['block-output']['element::p']['content'] . " [%another_input%]";;

	return $options;
}

//add_filter( 'wp_super_duper_options_hello_world', '_my_extra_arguments' );