Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fixed coding standards, code blocks and properly escape WC_Embed methods

This commit is contained in:
Claudio Sanches 2015-12-02 11:04:12 -02:00
parent 37d7dcb396
commit aa5e928dc1
1 changed files with 99 additions and 92 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
includes/class-wc-embed.php
View File

@ -1,16 +1,22 @@
<?php <?php
/**
* WooCommerce Product Embed.
*
* @version 2.4.11
* @package WooCommerce/Classes/Embed
* @category Class
* @author WooThemes
*/
if ( ! defined( 'ABSPATH' ) ) { if ( ! defined( 'ABSPATH' ) ) {
exit; exit;
} }
/** /**
* Embed Class which handles any WooCommerce Products that are embedded on this site or another site * Embed Class which handles any WooCommerce Products that are embedded on this site or another site.
* *
* @class WC_Embed * @class WC_Embed
* @version 2.4.11 * @version 2.4.11
* @package WooCommerce/Classes/Embed
* @category Class
* @author WooThemes * @author WooThemes
*/ */
class WC_Embed { class WC_Embed {
@ -22,44 +28,45 @@ class WC_Embed {
*/ */
public static function init() { public static function init() {
// filter all of the content that's going to be embedded // Filter all of the content that's going to be embedded.
add_filter( 'the_title', array( __CLASS__, 'the_title' ), 10 ); add_filter( 'the_title', array( __CLASS__, 'the_title' ), 10 );
add_filter( 'the_excerpt_embed', array( __CLASS__, 'the_excerpt' ), 10 ); add_filter( 'the_excerpt_embed', array( __CLASS__, 'the_excerpt' ), 10 );
// make sure no comments display. Doesn't make sense for products // Make sure no comments display. Doesn't make sense for products.
remove_action( 'embed_content_meta', 'print_embed_comments_button' ); remove_action( 'embed_content_meta', 'print_embed_comments_button' );
// in the comments place let's display the product rating // In the comments place let's display the product rating.
add_action( 'embed_content_meta', array( __CLASS__, 'get_ratings' ), 5 ); add_action( 'embed_content_meta', array( __CLASS__, 'get_ratings' ), 5 );
// Add some basic styles // Add some basic styles.
add_action( 'embed_head', array( __CLASS__, 'print_embed_styles' ) ); add_action( 'embed_head', array( __CLASS__, 'print_embed_styles' ) );
} }
/** /**
* Create the title for embedded products - we want to add the price to it * Create the title for embedded products - we want to add the price to it.
* *
* @return string
* @since 2.4.11 * @since 2.4.11
* @param string $title Embed title.
* @return string
*/ */
public static function the_title( $title ) { public static function the_title( $title ) {
// make sure we're only affecting embedded products // Make sure we're only affecting embedded products.
if ( self::is_embedded_product() ) { if ( self::is_embedded_product() ) {
// get product // Get product.
$_product = wc_get_product( get_the_ID() ); $_product = wc_get_product( get_the_ID() );
// add the price // Add the price.
$title = $title . '<span class="wc-embed-price">' . $_product->get_price_html() . '</span>'; $title = $title . '<span class="wc-embed-price">' . $_product->get_price_html() . '</span>';
} }
return $title; return $title;
} }
/** /**
* Check if this is an embedded product - to make sure we don't mess up regular posts * Check if this is an embedded product - to make sure we don't mess up regular posts.
* *
* @return bool
* @since 2.4.11 * @since 2.4.11
* @return bool
*/ */
public static function is_embedded_product() { public static function is_embedded_product() {
if ( function_exists( 'is_embed' ) && is_embed() && is_product() ) { if ( function_exists( 'is_embed' ) && is_embed() && is_product() ) {
@ -69,15 +76,16 @@ class WC_Embed {
} }
/** /**
* Create the excerpt for embedded products - we want to add the buy button to it * Create the excerpt for embedded products - we want to add the buy button to it.
* *
* @return string
* @since 2.4.11 * @since 2.4.11
* @param string $excerpt Embed short description.
* @return string
*/ */
public static function the_excerpt( $excerpt ) { public static function the_excerpt( $excerpt ) {
global $post; global $post;
// make sure we're only affecting embedded products // Make sure we're only affecting embedded products.
if ( self::is_embedded_product() ) { if ( self::is_embedded_product() ) {
if ( ! empty( $post->post_excerpt ) ) { if ( ! empty( $post->post_excerpt ) ) {
ob_start(); ob_start();
@ -85,8 +93,8 @@ class WC_Embed {
$excerpt = ob_get_clean(); $excerpt = ob_get_clean();
} }
// add the button // Add the button.
$excerpt.= self::product_buttons(); $excerpt .= self::product_buttons();
} }
return $excerpt; return $excerpt;
} }
@ -94,8 +102,8 @@ class WC_Embed {
/** /**
* Create the button to go to the product page for embedded products. * Create the button to go to the product page for embedded products.
* *
* @return string
* @since 2.4.11 * @since 2.4.11
* @return string
*/ */
public static function product_buttons() { public static function product_buttons() {
$_product = wc_get_product( get_the_ID() ); $_product = wc_get_product( get_the_ID() );
@ -103,33 +111,32 @@ class WC_Embed {
$button = '<a href="%s" class="wp-embed-more wc-embed-button">%s</a>'; $button = '<a href="%s" class="wp-embed-more wc-embed-button">%s</a>';
if ( $_product->is_type( 'simple' ) && $_product->is_purchasable() && $_product->is_in_stock() ) { if ( $_product->is_type( 'simple' ) && $_product->is_purchasable() && $_product->is_in_stock() ) {
$buttons[] = sprintf( $button, add_query_arg( 'add-to-cart', get_the_ID(), wc_get_cart_url() ), __( 'Buy Now', 'woocommerce' ) ); $buttons[] = sprintf( $button, esc_url( add_query_arg( 'add-to-cart', get_the_ID(), wc_get_cart_url() ) ), esc_html__( 'Buy Now', 'woocommerce' ) );
} }
$buttons[] = sprintf( $button, get_the_permalink(), __( 'Read More', 'woocommerce' ) ); $buttons[] = sprintf( $button, get_the_permalink(), esc_html__( 'Read More', 'woocommerce' ) );
return '<p>' . implode( ' ', $buttons ) . '</p>'; return '<p>' . implode( ' ', $buttons ) . '</p>';
} }
/** /**
* Prints the markup for the rating stars * Prints the markup for the rating stars.
* *
* @return string
* @since 2.4.11 * @since 2.4.11
*/ */
public static function get_ratings( $comments ) { public static function get_ratings() {
// make sure we're only affecting embedded products // Make sure we're only affecting embedded products.
if ( self::is_embedded_product() && ( $_product = wc_get_product( get_the_ID() ) ) && $_product->get_average_rating() > 0 ) { if ( self::is_embedded_product() && ( $_product = wc_get_product( get_the_ID() ) ) && $_product->get_average_rating() > 0 ) {
?> ?>
<div class="wc-embed-rating"> <div class="wc-embed-rating">
<?php printf( __( 'Rated %s out of 5', 'woocommerce' ), $_product->get_average_rating() ); ?> <?php echo esc_html( sprintf( __( 'Rated %s out of 5', 'woocommerce' ), $_product->get_average_rating() ) ); ?>
</div> </div>
<?php <?php
} }
} }
/** /**
* Basic styling * Basic styling.
*/ */
public static function print_embed_styles() { public static function print_embed_styles() {
if ( ! self::is_embedded_product() ) { if ( ! self::is_embedded_product() ) {
@ -138,17 +145,17 @@ class WC_Embed {
?> ?>
<style type="text/css"> <style type="text/css">
a.wc-embed-button { a.wc-embed-button {
border: 1px solid #ddd;
border-radius: 4px; border-radius: 4px;
padding: .5em; border: 1px solid #ddd;
box-shadow: 0px 1px 0 0px rgba(0, 0, 0, 0.05);
display:inline-block; display:inline-block;
box-shadow: 0px 1px 0 0px rgba(0,0,0,0.05); padding: .5em;
} }
a.wc-embed-button:hover, a.wc-embed-button:focus { a.wc-embed-button:hover, a.wc-embed-button:focus {
border: 1px solid #ccc; border: 1px solid #ccc;
box-shadow: 0px 1px 0 0px rgba(0,0,0,0.1); box-shadow: 0px 1px 0 0px rgba(0, 0, 0, 0.1);
text-decoration: none;
color: #999; color: #999;
text-decoration: none;
} }
.wp-embed-excerpt p { .wp-embed-excerpt p {
margin: 0 0 1em; margin: 0 0 1em;