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

Refactor the WC Conditional function coding standard

This commit is contained in:
shivapoudel 2015-02-10 16:42:33 +05:45
parent 1ec64a264d
commit 20c5774e70
1 changed files with 17 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

75
includes/wc-conditional-functions.php
View File

@ -4,20 +4,18 @@
*
* Functions for determining the current query/page.
*
* @author WooThemes
* @category Core
* @package WooCommerce/Functions
* @author WooThemes
* @category Core
* @package WooCommerce/Functions
* @version 2.3.0
*/
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly
exit;
}
/**
* is_woocommerce - Returns true if on a page which uses WooCommerce templates (cart and checkout are standard pages with shortcodes and thus are not included)
*
* @access public
* @return bool
*/
function is_woocommerce() {
@ -28,8 +26,6 @@ if ( ! function_exists( 'is_shop' ) ) {
/**
* is_shop - Returns true when viewing the product type archive (shop).
*
* @access public
* @return bool
*/
function is_shop() {
@ -41,8 +37,6 @@ if ( ! function_exists( 'is_product_taxonomy' ) ) {
/**
* is_product_taxonomy - Returns true when viewing a product taxonomy archive.
*
* @access public
* @return bool
*/
function is_product_taxonomy() {
@ -54,9 +48,7 @@ if ( ! function_exists( 'is_product_category' ) ) {
/**
* is_product_category - Returns true when viewing a product category.
*
* @access public
* @param string $term (default: '') The term slug your checking for. Leave blank to return true on any.
* @param string $term (default: '') The term slug your checking for. Leave blank to return true on any.
* @return bool
*/
function is_product_category( $term = '' ) {
@ -68,9 +60,7 @@ if ( ! function_exists( 'is_product_tag' ) ) {
/**
* is_product_tag - Returns true when viewing a product tag.
*
* @access public
* @param string $term (default: '') The term slug your checking for. Leave blank to return true on any.
* @param string $term (default: '') The term slug your checking for. Leave blank to return true on any.
* @return bool
*/
function is_product_tag( $term = '' ) {
@ -82,8 +72,6 @@ if ( ! function_exists( 'is_product' ) ) {
/**
* is_product - Returns true when viewing a single product.
*
* @access public
* @return bool
*/
function is_product() {
@ -95,8 +83,6 @@ if ( ! function_exists( 'is_cart' ) ) {
/**
* is_cart - Returns true when viewing the cart page.
*
* @access public
* @return bool
*/
function is_cart() {
@ -108,8 +94,6 @@ if ( ! function_exists( 'is_checkout' ) ) {
/**
* is_checkout - Returns true when viewing the checkout page.
*
* @access public
* @return bool
*/
function is_checkout() {
@ -121,8 +105,6 @@ if ( ! function_exists( 'is_checkout_pay_page' ) ) {
/**
* is_checkout_pay - Returns true when viewing the checkout's pay page.
*
* @access public
* @return bool
*/
function is_checkout_pay_page() {
@ -136,8 +118,6 @@ if ( ! function_exists( 'is_wc_endpoint_url' ) ) {
/**
* is_wc_endpoint_url - Check if an endpoint is showing
*
* @access public
* @param string $endpoint
* @return bool
*/
@ -169,8 +149,6 @@ if ( ! function_exists( 'is_account_page' ) ) {
/**
* is_account_page - Returns true when viewing an account page.
*
* @access public
* @return bool
*/
function is_account_page() {
@ -182,8 +160,6 @@ if ( ! function_exists( 'is_view_order_page' ) ) {
/**
* is_view_order_page - Returns true when on the view order page.
*
* @access public
* @return bool
*/
function is_view_order_page() {
@ -197,8 +173,6 @@ if ( ! function_exists( 'is_order_received_page' ) ) {
/**
* is_order_received_page - Returns true when viewing the order received page.
*
* @access public
* @return bool
*/
function is_order_received_page() {
@ -212,8 +186,6 @@ if ( ! function_exists( 'is_add_payment_method_page' ) ) {
/**
* is_add_payment_method_page - Returns true when viewing the add payment method page.
*
* @access public
* @return bool
*/
function is_add_payment_method_page() {
@ -227,8 +199,6 @@ if ( ! function_exists( 'is_lost_password_page' ) ) {
/**
* is_lost_password_page - Returns true when viewing the lost password page.
*
* @access public
* @return bool
*/
function is_lost_password_page() {
@ -242,8 +212,6 @@ if ( ! function_exists( 'is_ajax' ) ) {
/**
* is_ajax - Returns true when the page is loaded via ajax.
*
* @access public
* @return bool
*/
function is_ajax() {
@ -255,8 +223,6 @@ if ( ! function_exists( 'is_store_notice_showing' ) ) {
/**
* is_store_notice_showing - Returns true when store notice is active.
*
* @access public
* @return bool
*/
function is_store_notice_showing() {
@ -268,8 +234,6 @@ if ( ! function_exists( 'is_filtered' ) ) {
/**
* is_filtered - Returns true when filtering products using layered nav or price sliders.
*
* @access public
* @return bool
*/
function is_filtered() {
@ -283,9 +247,8 @@ if ( ! function_exists( 'taxonomy_is_product_attribute' ) ) {
/**
* Returns true when the passed taxonomy name is a product attribute.
*
* @uses $wc_product_attributes global which stores taxonomy names upon registration
* @param string $name of the attribute
* @uses $wc_product_attributes global which stores taxonomy names upon registration
* @param string $name of the attribute
* @return bool
*/
function taxonomy_is_product_attribute( $name ) {
@ -299,14 +262,13 @@ if ( ! function_exists( 'meta_is_product_attribute' ) ) {
/**
* Returns true when the passed meta name is a product attribute.
*
* @param string $name of the attribute
* @param mixed $value
* @param int $product_id
* @param string $name of the attribute
* @param mixed $value
* @param int $product_id
* @return bool
*/
function meta_is_product_attribute( $name, $value, $product_id ) {
$product = wc_get_product( $product_id );
$product = wc_get_product( $product_id );
if ( $product->product_type != 'variation' ) {
return false;
@ -322,7 +284,6 @@ if ( ! function_exists( 'wc_tax_enabled' ) ) {
/**
* Are store-wide taxes enabled?
*
* @return bool
*/
function wc_tax_enabled() {
@ -334,7 +295,6 @@ if ( ! function_exists( 'wc_prices_include_tax' ) ) {
/**
* Are prices inclusive of tax?
*
* @return bool
*/
function wc_prices_include_tax() {
@ -348,12 +308,12 @@ if ( ! function_exists( 'wc_prices_include_tax' ) ) {
* + starts with `action.woocommerce_` or `action.wc_`
* + it has a valid resource & event
*
* @param string $topic webhook topic
* @param string $topic webhook topic
* @return bool true if valid, false otherwise
*/
function wc_is_webhook_valid_topic( $topic ) {
// custom topics are prefixed with woocommerce_ or wc_ are valid
// Custom topics are prefixed with woocommerce_ or wc_ are valid
if ( 0 === strpos( $topic, 'action.woocommerce_' ) || 0 === strpos( $topic, 'action.wc_' ) ) {
return true;
}
@ -378,18 +338,17 @@ function wc_is_webhook_valid_topic( $topic ) {
/**
* Simple check for validating a URL, it must start with http:// or https://
* and pass FILTER_VALIDATE_URL validation
*
* @param string $url
* @param string $url
* @return bool
*/
function wc_is_valid_url( $url ) {
// must start with http:// or https://
// Must start with http:// or https://
if ( 0 !== strpos( $url, 'http://' ) && 0 !== strpos( $url, 'https://' ) ) {
return false;
}
// must pass validation
// Must pass validation
if ( ! filter_var( $url, FILTER_VALIDATE_URL ) ) {
return false;
}