podlove / podlove-subscribe-button-wp-plugin

podlove.php

<?php
/**
 * Plugin Name: Podlove Subscribe Button
 * Plugin URI:  https://wordpress.org/extend/plugins/podlove-subscribe-button/
 * Description: Brings the Podlove Subscribe Button to your WordPress installation.
 * Version:     1.3.11
 * Author:      Podlove
 * Author URI:  https://podlove.org
 * License:     MIT
 * License URI: license.txt
 * Text Domain: podlove-subscribe-button
 * Domain Path: /languages
 */

$correct_php_version = version_compare( phpversion(), "5.3", ">=" );

if ( ! $correct_php_version ) {
	printf( __( 'Podlove Subscribe Button Plugin requires %s or higher.<br>', 'podlove-subscribe-button' ), '<code>PHP 5.3</code>' );

All output should be run through an escaping function (see the Security sections in the WordPress Developer Handbooks), found '__'.

	echo '<br />';
	printf( __( 'You are running %s', 'podlove-subscribe-button' ), '<code>PHP ' . phpversion() . '</code>' );

All output should be run through an escaping function (see the Security sections in the WordPress Developer Handbooks), found '__'.

A gettext call containing placeholders was found, but was not accompanied by a "translators:" comment on the line above to clarify the meaning of the placeholders.

All output should be run through an escaping function (see the Security sections in the WordPress Developer Handbooks), found 'phpversion'.

	exit;
}

// Constants

Inline comments must end in full-stops, exclamation marks, or question marks

require('constants.php');
require('settings/buttons.php');
// Models

Inline comments must end in full-stops, exclamation marks, or question marks

require('model/base.php');
require('model/button.php');
require('model/network_button.php');
// Table

Inline comments must end in full-stops, exclamation marks, or question marks

require('settings/buttons_list_table.php');
// Media Types
require('media_types.php');
// Widget
require('widget.php');
// Version control
require('version.php');
// Helper functions
require('helper.php');

add_action( 'admin_menu', array( 'PodloveSubscribeButton', 'admin_menu') );
if ( is_multisite() )
	add_action( 'network_admin_menu', array( 'PodloveSubscribeButton', 'admin_network_menu') );

add_action( 'admin_init', array( 'PodloveSubscribeButton\Settings\Buttons', 'process_form' ) );
register_activation_hook( __FILE__, array( 'PodloveSubscribeButton', 'build_models' ) );

// Register Settings
add_action( 'admin_init', function () {

The opening parenthesis of a multi-line function call should be the last content on the line.

For multi-line function calls, each argument should be on a separate line.

	$settings = array( 'size', 'autowidth', 'style', 'format', 'color' );

	foreach ( $settings as $setting ) {
		if ( 'autowidth' == $setting ) {
			$args = array(
				'sanitize_callback' => array( 'PodloveSubscribeButton', 'sanitize_settings' ),
			);
			register_setting( 'podlove-subscribe-button', 'podlove_subscribe_button_default_' . $setting, $args );
		} else {
			register_setting( 'podlove-subscribe-button', 'podlove_subscribe_button_default_' . $setting );
		}
	}
} );

add_shortcode( 'podlove-subscribe-button', array( 'PodloveSubscribeButton', 'shortcode' ) );

add_action( 'plugins_loaded', function () {
	load_plugin_textdomain( 'podlove-subscribe-button', false, dirname(plugin_basename( __FILE__)) . '/languages/');

Expected 1 spaces after opening parenthesis; 0 found

Expected 1 spaces before closing parenthesis; 0 found

} );

PodloveSubscribeButton::run();


class PodloveSubscribeButton {

	public static function run() {

Missing doc comment for function run()

		add_action( 'admin_enqueue_scripts', array( __CLASS__, 'enqueue_assets' ) );
	}

Expected 1 blank line before closing function brace; 0 found

	public static function enqueue_assets( $hook ) {

Method name "PodloveSubscribeButton::enqueue_assets" is not in camel caps format

Missing doc comment for function enqueue_assets()

		$pages = array( 'settings_page_podlove-subscribe-button', 'widgets.php' );

		if ( ! in_array( $hook, $pages )  ) {

Not using strict comparison for in_array; supply true for third argument.

Expected exactly one space before closing parenthesis; " " found.

			return;
		}

		// CSS Stylesheet

Inline comments must end in full-stops, exclamation marks, or question marks

		wp_register_style( 'podlove-subscribe-button', plugin_dir_url( __FILE__ ) . 'style.css', false, '1.3.6' );

false of type false is incompatible with the type string[] expected by parameter $deps of wp_register_style().

		wp_enqueue_style( 'podlove-subscribe-button' );

		// Admin JS

Inline comments must end in full-stops, exclamation marks, or question marks

		wp_enqueue_style( 'wp-color-picker' );
		wp_register_script( 'podlove-subscribe-button-admin-tools', plugin_dir_url( __FILE__ ) . 'js/admin.js', array( 'jquery', 'wp-color-picker' ), '1.3.6' );

In footer ($in_footer) is not set explicitly wp_register_script; It is recommended to load scripts in the footer. Please set this value to true to load it in the footer, or explicitly false if it should be loaded in the header.

		$js_translations = array(
			'media_library' => __( 'Media Library', 'podlove-subscribe-button' ),
			'use_for'       => __( 'Use for Podcast Cover Art', 'podlove-subscribe-button' ),
		);
		wp_localize_script( 'podlove-subscribe-button-admin-tools', 'i18n', $js_translations );
		wp_enqueue_script( 'podlove-subscribe-button-admin-tools' );
	}

Expected 1 blank line before closing function brace; 0 found

	public static function admin_menu() {
		add_options_page(
				'Podlove Subscribe Button Options',
				'Podlove Subscribe Button',
				'manage_options',
				'podlove-subscribe-button',
				array( 'PodloveSubscribeButton\Settings\Buttons', 'page')
			);
	}

Expected 1 blank line before closing function brace; 0 found

	public static function admin_network_menu() {
		add_submenu_page(
				'settings.php',
				'Podlove Subscribe Button Options',
				'Podlove Subscribe Button',
				'manage_options',
				'podlove-subscribe-button',
				array( 'PodloveSubscribeButton\Settings\Buttons', 'page')
			);
	}

Expected 1 blank line before closing function brace; 0 found

	public static function build_models() {
		// Build Databases
		\PodloveSubscribeButton\Model\Button::build();
		if ( is_multisite() )
			\PodloveSubscribeButton\Model\NetworkButton::build();

		// Set Button "default" values
		$default_values = array(
				'size' => 'big',
				'autowidth' => 'on',
				'color' => '#599677',
				'style' => 'filled',
				'format' => 'rectangle'
			);

		foreach ($default_values as $option => $default_value) {
			if ( ! get_option('podlove_subscribe_button_default_' . $option ) ) {
				update_option('podlove_subscribe_button_default_' . $option, $default_value);
			}
		}
	}

Expected 1 blank line before closing function brace; 0 found

	public static function shortcode( $args ) {
		if ( ! $args || ! isset($args['button']) ) {
			return __('You need to create a Button first and provide its ID.', 'podlove-subscribe-button');
		} else {
			$buttonid = $args['button'];
		}

		// Fetch the (network)button by it's name
		if ( ! $button = \PodloveSubscribeButton\Model\Button::get_button_by_name($args['button']) )
			return sprintf( __('Oops. There is no button with the ID "%s".', 'podlove-subscribe-button'), $args['button'] );

		// Get button styling and options
		$autowidth = self::interpret_width_attribute( self::get_array_value_with_fallback($args, 'width') );
		$size = self::get_attribute( 'size', self::get_array_value_with_fallback($args, 'size') );

It seems like self::get_array_value_with_fallback($args, 'size') can also be of type false; however, parameter $attribute_value of PodloveSubscribeButton::get_attribute() does only seem to accept string, maybe add an additional type check?

		$style = self::get_attribute( 'style', self::get_array_value_with_fallback($args, 'style') );
		$format = self::get_attribute( 'format', self::get_array_value_with_fallback($args, 'format') );
		$color = self::get_attribute( 'color', self::get_array_value_with_fallback($args, 'color') );

		if ( isset($args['language']) ) {
			$language = $args['language'];
		} else {
			$language = 'en';
		}

		if ( isset($args['color']) ) {
			$color = $args['color'];
		} else {
			$color = get_option('podlove_subscribe_button_default_color', '#599677');
		}

		if ( isset($args['hide']) && $args['hide'] == 'true' ) {
			$hide = true;
		} else {
			$hide = false;
		}

		// Render button
		return $button->render($size, $autowidth, $style, $format, $color, $hide, $buttonid, $language);
	}

Expected 1 blank line before closing function brace; 0 found

	public static function get_array_value_with_fallback($args, $key) {
		if ( isset($args[$key]) )
			return $args[$key];

		return false;
	}

	/**
	 * @param  string $attribute

Missing parameter comment

	 * @param  string $attribute_value
	 * @return string
	 */
	private static function get_attribute($attribute=null, $attribute_value=null) {
		if ( isset($attribute_value) && ctype_alnum($attribute_value) && key_exists( $attribute_value, \PodloveSubscribeButton\Model\Button::$$attribute ) ) {
			return $attribute_value;
		} else {
			return get_option('podlove_subscribe_button_default_' . $attribute, \PodloveSubscribeButton\Model\Button::$properties[$attribute]);
		}
	}

	/**
	 * Interprets the provided width attribute and return either auto- or a specific width
	 * @param  string $width_attribute
	 * @return string
	 */
	private static function interpret_width_attribute( $width_attribute = null ) {
		if ( $width_attribute == 'auto' )
			return 'on';
		if ( $width_attribute && $width_attribute !== 'auto' )
			return 'off';

		return get_option('podlove_subscribe_button_default_autowidth', 'on');
	}

	public static function sanitize_settings( $input = null ) {

Method name "PodloveSubscribeButton::sanitize_settings" is not in camel caps format

Missing doc comment for function sanitize_settings()

		if ( null == $input ) {

Found: ==. Use strict comparisons (=== or !==).

			return 'off';
		} elseif ( 'on' == $input ) {

Found: ==. Use strict comparisons (=== or !==).

			return $input;
		}
	}

Expected 1 blank line before closing function brace; 0 found

}