forked from mirror/_s
Tweaks to docblocks.
This commit is contained in:
parent
b87901e508
commit
f26859169b
|
@ -24,7 +24,7 @@ function _s_woocommerce_setup() {
|
|||
add_action( 'after_setup_theme', '_s_woocommerce_setup' );
|
||||
|
||||
/**
|
||||
* WooCommerce specific scripts & stylesheets
|
||||
* WooCommerce specific scripts & stylesheets.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
|
@ -34,7 +34,7 @@ function _s_woocommerce_scripts() {
|
|||
add_action( 'wp_enqueue_scripts', '_s_woocommerce_scripts' );
|
||||
|
||||
/**
|
||||
* Disable the default WooCommerce stylesheet
|
||||
* Disable the default WooCommerce stylesheet.
|
||||
*
|
||||
* Removing the default WooCommerce stylesheet and enqueing your own will
|
||||
* protect you during WooCommerce core updates.
|
||||
|
@ -44,10 +44,10 @@ add_action( 'wp_enqueue_scripts', '_s_woocommerce_scripts' );
|
|||
add_filter( 'woocommerce_enqueue_styles', '__return_empty_array' );
|
||||
|
||||
/**
|
||||
* Add 'woocommerce-active' class to the body tag
|
||||
* Add 'woocommerce-active' class to the body tag.
|
||||
*
|
||||
* @param array $classes css classes applied to the body tag.
|
||||
* @return array $classes modified to include 'woocommerce-active' class
|
||||
* @param array $classes CSS classes applied to the body tag.
|
||||
* @return array $classes modified to include 'woocommerce-active' class.
|
||||
*/
|
||||
function _s_woocommerce_active_body_class( $classes ) {
|
||||
$classes[] = 'woocommerce-active';
|
||||
|
@ -57,9 +57,9 @@ function _s_woocommerce_active_body_class( $classes ) {
|
|||
add_filter( 'body_class', '_s_woocommerce_active_body_class' );
|
||||
|
||||
/**
|
||||
* Products per page
|
||||
* Products per page.
|
||||
*
|
||||
* @return integer number of products
|
||||
* @return integer number of products.
|
||||
*/
|
||||
function _s_woocommerce_products_per_page() {
|
||||
return 12;
|
||||
|
@ -67,9 +67,9 @@ function _s_woocommerce_products_per_page() {
|
|||
add_filter( 'loop_shop_per_page', '_s_woocommerce_products_per_page' );
|
||||
|
||||
/**
|
||||
* Product gallery thumnbail columns
|
||||
* Product gallery thumnbail columns.
|
||||
*
|
||||
* @return integer number of columns
|
||||
* @return integer number of columns.
|
||||
*/
|
||||
function _s_woocommerce_thumbnail_columns() {
|
||||
return 4;
|
||||
|
@ -77,9 +77,9 @@ function _s_woocommerce_thumbnail_columns() {
|
|||
add_filter( 'woocommerce_product_thumbnails_columns', '_s_woocommerce_thumbnail_columns' );
|
||||
|
||||
/**
|
||||
* Default loop columns on product archives
|
||||
* Default loop columns on product archives.
|
||||
*
|
||||
* @return integer products per row
|
||||
* @return integer products per row.
|
||||
*/
|
||||
function _s_woocommerce_loop_columns() {
|
||||
return 3;
|
||||
|
@ -87,10 +87,10 @@ function _s_woocommerce_loop_columns() {
|
|||
add_filter( 'loop_shop_columns', '_s_woocommerce_loop_columns' );
|
||||
|
||||
/**
|
||||
* Related Products Args
|
||||
* Related Products Args.
|
||||
*
|
||||
* @param array $args related products args.
|
||||
* @return array $args related products args
|
||||
* @return array $args related products args.
|
||||
*/
|
||||
function _s_woocommerce_related_products_args( $args ) {
|
||||
$args = wp_parse_args( array( 'posts_per_page' => 3, 'columns' => 3 ), $args );
|
||||
|
@ -100,7 +100,7 @@ add_filter( 'woocommerce_output_related_products_args', '_s_woocommerce_related_
|
|||
|
||||
if ( ! function_exists( '_s_woocommerce_product_columns_wrapper' ) ) {
|
||||
/**
|
||||
* Product columns wrapper
|
||||
* Product columns wrapper.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
|
@ -113,7 +113,7 @@ add_action( 'woocommerce_before_shop_loop', '_s_woocommerce_product_columns_wrap
|
|||
|
||||
if ( ! function_exists( '_s_woocommerce_product_columns_wrapper_close' ) ) {
|
||||
/**
|
||||
* Product columns wrapper close
|
||||
* Product columns wrapper close.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
|
@ -124,15 +124,16 @@ if ( ! function_exists( '_s_woocommerce_product_columns_wrapper_close' ) ) {
|
|||
add_action( 'woocommerce_after_shop_loop', '_s_woocommerce_product_columns_wrapper_close', 40 );
|
||||
|
||||
/**
|
||||
* Remove default WooCommerce wrapper
|
||||
* Remove default WooCommerce wrapper.
|
||||
*/
|
||||
remove_action( 'woocommerce_before_main_content', 'woocommerce_output_content_wrapper', 10 );
|
||||
remove_action( 'woocommerce_after_main_content', 'woocommerce_output_content_wrapper_end', 10 );
|
||||
|
||||
if ( ! function_exists( '_s_woocommerce_wrapper_before' ) ) {
|
||||
/**
|
||||
* Before Content
|
||||
* Wraps all WooCommerce content in wrappers which match the theme markup
|
||||
* Before Content.
|
||||
*
|
||||
* Wraps all WooCommerce content in wrappers which match the theme markup.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
|
@ -147,8 +148,9 @@ add_action( 'woocommerce_before_main_content', '_s_woocommerce_wrapper_before' )
|
|||
|
||||
if ( ! function_exists( '_s_woocommerce_wrapper_after' ) ) {
|
||||
/**
|
||||
* After Content
|
||||
* Closes the wrapping divs
|
||||
* After Content.
|
||||
*
|
||||
* Closes the wrapping divs.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
|
@ -162,7 +164,7 @@ if ( ! function_exists( '_s_woocommerce_wrapper_after' ) ) {
|
|||
add_action( 'woocommerce_after_main_content', '_s_woocommerce_wrapper_after' );
|
||||
|
||||
/**
|
||||
* Sample implementation of the WooCommerce Mini Cart
|
||||
* Sample implementation of the WooCommerce Mini Cart.
|
||||
*
|
||||
* You can add the WooCommerce Mini Cart to header.php like so ...
|
||||
*
|
||||
|
@ -175,11 +177,12 @@ add_action( 'woocommerce_after_main_content', '_s_woocommerce_wrapper_after' );
|
|||
|
||||
if ( ! function_exists( '_s_woocommerce_cart_link_fragment' ) ) {
|
||||
/**
|
||||
* Cart Fragments
|
||||
* Ensure cart contents update when products are added to the cart via AJAX
|
||||
* Cart Fragments.
|
||||
*
|
||||
* Ensure cart contents update when products are added to the cart via AJAX.
|
||||
*
|
||||
* @param array $fragments Fragments to refresh via AJAX.
|
||||
* @return array Fragments to refresh via AJAX
|
||||
* @return array Fragments to refresh via AJAX.
|
||||
*/
|
||||
function _s_woocommerce_cart_link_fragment( $fragments ) {
|
||||
ob_start();
|
||||
|
@ -193,8 +196,9 @@ add_filter( 'woocommerce_add_to_cart_fragments', '_s_woocommerce_cart_link_fragm
|
|||
|
||||
if ( ! function_exists( '_s_woocommerce_cart_link' ) ) {
|
||||
/**
|
||||
* Cart Link
|
||||
* Displayed a link to the cart including the number of items present and the cart total
|
||||
* Cart Link.
|
||||
*
|
||||
* Displayed a link to the cart including the number of items present and the cart total.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
|
@ -210,7 +214,7 @@ if ( ! function_exists( '_s_woocommerce_cart_link' ) ) {
|
|||
|
||||
if ( ! function_exists( '_s_woocommerce_header_cart' ) ) {
|
||||
/**
|
||||
* Display Header Cart
|
||||
* Display Header Cart.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
|
|
Reference in New Issue