lightspeeddevelopment / lsx-team

includes/functions.php

<?php
/**
 * Functions
 *
 * @package   LSX Team
 * @author    LightSpeed
 * @license   GPL3
 * @link
 * @copyright 2016 LightSpeed
 */

/**
 * Add our action to init to set up our vars first.
 */
function lsx_team_load_plugin_textdomain() {

Expected 2 blank lines before function; 1 found

	load_plugin_textdomain( 'lsx-team', false, basename( LSX_TEAM_PATH ) . '/languages' );
}

Expected 2 blank lines after function; 0 found

Expected 1 blank line before closing function brace; 0 found

add_action( 'init', 'lsx_team_load_plugin_textdomain' );

/**
 * Wrapper function around cmb2_get_option
 * @since  0.1.0

There must be exactly one blank line before the tags in a doc comment

 * @param  string $key     Options array key

Superfluous parameter comment

Parameter comment must end with a full stop

 * @param  mixed  $default Optional default value

Superfluous parameter comment

Parameter comment must end with a full stop

 * @return mixed           Option value
 */
function team_get_options() {

Expected 2 blank lines before function; 1 found

	$options = array();
	if ( function_exists( 'tour_operator' ) ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

		$options = get_option( '_lsx-to_settings', false );
	} else {
		$options = get_option( '_lsx_settings', false );

		if ( false === $options ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

			$options = get_option( '_lsx_lsx-settings', false );
		}
	}

	// If there are new CMB2 options available, then use those.
	$new_options = get_option( 'lsx_team_options', false );
	if ( false !== $new_options ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

		$options['display'] = $new_options;
	}

No blank line found after control structure

	return $options;
}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

/**
 * Wrapper function around cmb2_get_option
 * @since  0.1.0

There must be exactly one blank line before the tags in a doc comment

 * @param  string $key     Options array key

Parameter comment must end with a full stop

 * @param  mixed  $default Optional default value

Parameter comment must end with a full stop

 * @return mixed           Option value
 */
function team_get_option( $key = '', $default = false ) {
	$options = array();
	$value   = $default;
	if ( function_exists( 'tour_operator' ) ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

		$options = get_option( '_lsx-to_settings', false );
	} else {
		$options = get_option( '_lsx_settings', false );

		if ( false === $options ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

			$options = get_option( '_lsx_lsx-settings', false );
		}
	}

	// If there are new CMB2 options available, then use those.
	$new_options = get_option( 'lsx_team_options', false );
	if ( false !== $new_options ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

		$options['display'] = $new_options;
	}

	if ( isset( $options['display'] ) && isset( $options['display'][ $key ] ) ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

		$value = $options['display'][ $key ];
	}

No blank line found after control structure

	return $value;
}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

/**

Doc comment for parameter "$args" missing

 * Wraps the output class in a function to be called in templates
 */
function lsx_team( $args ) {
	$lsx_team = new LSX_Team;

Parenthesis should always be used when instantiating a new object.

	echo wp_kses_post( $lsx_team->output( $args ) );
}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

/**

Doc comment for parameter "$atts" missing

 * Shortcode
 */
function lsx_team_shortcode( $atts ) {
	$lsx_team = new LSX_Team;

Parenthesis should always be used when instantiating a new object.

	return $lsx_team->output( $atts );
}

Expected 2 blank lines after function; 0 found

Expected 1 blank line before closing function brace; 0 found

add_shortcode( 'lsx_team', 'lsx_team_shortcode' );

/**
 * Creates the feature images sizes for the REST API responses.
 *
 * @param [type] $object team.

The doc comment [type] at position 0 could not be parsed: Unknown type name '[' at position 0 in [type].

 * @param [type] $field_name name.
 * @param [type] $request request.
 */
function lsx_team_get_images_urls( $object, $field_name, $request ) {

Expected 2 blank lines before function; 1 found

	$medium     = wp_get_attachment_image_src( get_post_thumbnail_id( $object->id ), 'medium' );
	$medium_url = $medium['0'];

	$large     = wp_get_attachment_image_src( get_post_thumbnail_id( $object->id ), 'large' );
	$large_url = $large['0'];

	return array(
		'medium' => $medium_url,
		'large'  => $large_url,
	);
}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

/**
 * Modify REST API responses to get better media urls for the blocks.
 *
 * @return void
 */
function lsx_team_register_images_field() {
	register_rest_field(
		'team',
		'images',
		array(
			'get_callback'    => 'lsx_team_get_images_urls',
			'update_callback' => null,
			'schema'          => null,
		)
	);
}

Expected 2 blank lines after function; 0 found

Expected 1 blank line before closing function brace; 0 found

add_action( 'rest_api_init', 'lsx_team_register_images_field' );

/**
 * Creates the Additional Meta the REST API responses.
 *
 * @param [type] $object team.

The doc comment [type] at position 0 could not be parsed: Unknown type name '[' at position 0 in [type].

 * @param [type] $field_name name.
 * @param [type] $request request.
 */
function lsx_team_get_additional_meta( $object, $field_name, $request ) {

Expected 2 blank lines before function; 1 found

	$role      = get_the_terms( get_the_ID(), 'team_role' );

It seems like get_the_ID() can also be of type false; however, parameter $post of get_the_terms() does only seem to accept WP_Post|integer, maybe add an additional type check?

	$job_title = get_post_meta( get_the_ID(), 'lsx_job_title', true );

It seems like get_the_ID() can also be of type false; however, parameter $post_id of get_post_meta() does only seem to accept integer, maybe add an additional type check?

	$email     = get_post_meta( get_the_ID(), 'lsx_email_contact', true );
	$phone     = get_post_meta( get_the_ID(), 'lsx_tel', true );
	$skype     = get_post_meta( get_the_ID(), 'lsx_skype', true );
	$facebook  = get_post_meta( get_the_ID(), 'lsx_facebook', true );
	$twitter   = get_post_meta( get_the_ID(), 'lsx_twitter', true );
	$linkedin  = get_post_meta( get_the_ID(), 'lsx_linkedin', true );

	return array(
		'role'      => $role,
		'job_title' => $job_title,
		'email'     => $email,
		'phone'     => $phone,
		'skype'     => $skype,
		'facebook'  => $facebook,
		'twitter'   => $twitter,
		'linkedin'  => $linkedin,
	);
}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

/**
 * Modify REST API responses to get better social urls for the blocks.
 *
 * @return void
 */
function lsx_team_register_additional_meta() {
	register_rest_field(
		'team',
		'additional_meta',
		array(
			'get_callback'    => 'lsx_team_get_additional_meta',
			'update_callback' => null,
			'schema'          => null,
		)
	);
}

Expected 2 blank lines after function; 0 found

Expected 1 blank line before closing function brace; 0 found

add_action( 'rest_api_init', 'lsx_team_register_additional_meta' );