%PDF-
%PDF-
Mini Shell
Mini Shell
<?php
/**
* @package The_SEO_Framework\Compat\Plugin\WooCommerce
* @subpackage The_SEO_Framework\Compatibility
*/
namespace The_SEO_Framework;
\defined( 'THE_SEO_FRAMEWORK_PRESENT' ) and \tsf()->_verify_include_secret( $_secret ) or die;
\add_action( 'woocommerce_init', __NAMESPACE__ . '\\_init_wc_compat' );
/**
* Initializes WooCommerce compatibility.
*
* @since 3.1.0
* @since 4.0.3 Added primary term support to products.
* @since 4.1.1 Added primary term support to category widgets.
* @since 4.1.4 1. Now unbinds wc_page_noindex action.
* 2. Now unbinds wc_page_no_robots filter.
* 3. Now modifies the SEO Bar.
* @access private
* @uses \is_product()
*/
function _init_wc_compat() {
\add_action(
'the_seo_framework_do_before_output',
static function() {
/**
* Removes TSF breadcrumbs. WooCommerce outputs theirs.
*/
if ( \function_exists( '\\is_product' ) && \is_product() ) {
\add_filter( 'the_seo_framework_json_breadcrumb_output', '__return_false' );
}
}
);
$tsf = \tsf();
// Adjust the product link acknowledging the primary category.
\add_filter( 'wc_product_post_type_link_product_cat', [ $tsf, '_adjust_post_link_category' ], 10, 3 );
// Adjust the structured-data breadcrumb primary term. Coincidentally(?), it uses the same filter structure; although, it misses the $post object.
\add_filter( 'woocommerce_breadcrumb_main_term', [ $tsf, '_adjust_post_link_category' ], 10, 2 );
// Adjust the widget's tree primary term. Coincidentally(?), it uses the same filter structure; although, it misses the $post object.
\add_filter( 'woocommerce_product_categories_widget_main_term', [ $tsf, '_adjust_post_link_category' ], 10, 2 );
// WP <5.7
\remove_action( 'wp_head', 'wc_page_noindex' );
// WP 5.7+
\remove_filter( 'wp_robots', 'wc_page_no_robots' );
}
/**
* Sets the correct shop ID on the shop page.
*
* @since 4.2.0
* @access private
*
* @param int|WP_Post|null $post Post ID or post object.
* @return bool
*/
function _is_shop( $post = null ) {
if ( isset( $post ) ) {
$id = \is_int( $post )
? $post
: ( \get_post( $post )->ID ?? 0 );
$is_shop = (int) \get_option( 'woocommerce_shop_page_id' ) === $id;
} else {
$is_shop = ! \is_admin() && \function_exists( 'is_shop' ) && \is_shop();
}
return $is_shop;
}
\add_filter( 'the_seo_framework_real_id', __NAMESPACE__ . '\\_set_real_id_wc_shop' );
/**
* Sets the correct shop ID on the shop page.
*
* @since 4.0.5
* @access private
*
* @param int $id The current ID.
* @return int
*/
function _set_real_id_wc_shop( $id ) {
// phpcs:ignore, TSF.Performance.Opcodes.ShouldHaveNamespaceEscape -- local func
if ( _is_shop() )
$id = (int) \get_option( 'woocommerce_shop_page_id' );
return $id;
}
\add_filter( 'the_seo_framework_is_singular_archive', __NAMESPACE__ . '\\_set_shop_singular_archive', 10, 2 );
/**
* Sets singular archives for the WC shop page.
*
* @since 4.0.5
* @access private
*
* @param bool $is_singular_archive Whether the post ID is a singular archive.
* @param int|null $id The supplied post ID. Null when in the loop.
* @return bool
*/
function _set_shop_singular_archive( $is_singular_archive, $id ) {
// phpcs:ignore, TSF.Performance.Opcodes.ShouldHaveNamespaceEscape -- local func
return $is_singular_archive || _is_shop( $id );
}
\add_filter( 'the_seo_framework_is_shop', __NAMESPACE__ . '\\_set_wc_is_shop', 10, 2 );
/**
* Sets the is_shop query.
*
* @since 4.0.5
* @since 4.1.4 Now handles the assertion fully.
* @access private
* @TODO is this redundant for TSF? -> yes. lol. It's used nowhere, for now...
*
* @param bool $is_shop Whether this is a shop page.
* @param int|WP_Post|null $post Post ID or post object.
* @return bool
*/
function _set_wc_is_shop( $is_shop, $post ) {
// phpcs:ignore, TSF.Performance.Opcodes.ShouldHaveNamespaceEscape -- local func
return $is_shop || _is_shop( $post );
}
\add_filter( 'the_seo_framework_is_product', __NAMESPACE__ . '\\_set_wc_is_product', 10, 2 );
/**
* Sets the is_product query.
*
* @since 4.0.5
* @since 4.1.4 Now handles the assertion fully.
*
* @param bool $is_product Whether this is a product page.
* @param int|WP_Post|null $post Post ID or post object.
* @return bool
*/
function _set_wc_is_product( $is_product, $post ) {
if ( $is_product ) return $is_product;
if ( $post ) {
$is_product = 'product' === \get_post_type( $post );
} else {
$is_product = \function_exists( 'is_product' ) && \is_product();
}
return $is_product;
}
\add_filter( 'the_seo_framework_is_product_admin', __NAMESPACE__ . '\\_set_wc_is_product_admin' );
/**
* Sets the is_product_admin query.
*
* @since 4.0.5
* @since 4.1.4 Now handles the assertion fully.
* @access private
* @TODO is this redundant for TSF? Yup. This very much is because we do not show an interface for OG types.
*
* @param bool $is_product_admin Whether this is a product admin query.
* @return bool
*/
function _set_wc_is_product_admin( $is_product_admin ) {
if ( $is_product_admin ) return $is_product_admin;
$tsf = \tsf();
return $tsf->is_singular_admin() && 'product' === $tsf->get_admin_post_type();
}
\add_filter( 'the_seo_framework_robots_meta_array', __NAMESPACE__ . '\\_set_wc_noindex_defaults', 10, 3 );
/**
* Sets 'noindex' default values for WooCommerce's restrictive pages.
*
* @since 4.1.4
* @access private
*
* @param array $meta The parsed robots meta. {
* string 'noindex', ideally be empty or 'noindex'
* string 'nofollow', ideally be empty or 'nofollow'
* string 'noarchive', ideally be empty or 'noarchive'
* string 'max_snippet', ideally be empty or 'max-snippet:<R>=-1>'
* string 'max_image_preview', ideally be empty or 'max-image-preview:<none|standard|large>'
* string 'max_video_preview', ideally be empty or 'max-video-preview:<R>=-1>'
* }
* @param array|null $args The query arguments. Contains 'id' and 'taxonomy'.
* Is null when query is autodetermined.
* @param int <bit> $options The generator settings. {
* 0 = 0b00: Ignore nothing.
* 1 = 0b01: Ignore protection. (\The_SEO_Framework\ROBOTS_IGNORE_PROTECTION)
* 2 = 0b10: Ignore post/term setting. (\The_SEO_Framework\ROBOTS_IGNORE_SETTINGS)
* 3 = 0b11: Ignore protection and post/term setting.
* }
* @return array
*/
function _set_wc_noindex_defaults( $meta, $args, $options ) {
// Nothing to do here...
if ( 'noindex' === $meta['noindex'] ) return $meta;
$tsf = \tsf();
if ( null === $args ) {
if ( \is_singular() )
$page_id = $tsf->get_the_real_ID();
} else {
if ( '' === $args['taxonomy'] )
$page_id = $args['id'];
}
// No page_id was found: unsupported query.
if ( empty( $page_id ) ) return $meta;
static $page_ids;
if ( ! isset( $page_ids ) ) {
if ( ! \function_exists( '\\wc_get_page_id' ) ) return $meta;
$page_ids = array_filter( [ \wc_get_page_id( 'cart' ), \wc_get_page_id( 'checkout' ), \wc_get_page_id( 'myaccount' ) ] );
}
// This current page isn't a WC cart/checkout/myaccount page.
if ( ! \in_array( $page_id, $page_ids, true ) ) return $meta;
// Set the default.
if ( $options & \The_SEO_Framework\ROBOTS_IGNORE_SETTINGS ) {
$meta['noindex'] = 'noindex';
} elseif ( 0 === $tsf->s_qubit( $tsf->get_post_meta_item( '_genesis_noindex', $page_id ) ) ) {
$meta['noindex'] = 'noindex';
}
return $meta;
}
\add_action( 'the_seo_framework_seo_bar', __NAMESPACE__ . '\\_assert_wc_noindex_defaults_seo_bar' );
/**
* Appends noindex default checks to the noindex item of the SEO Bar for pages.
*
* @since 4.1.4
* @access private
*
* @param string $interpreter The interpreter class name.
*/
function _assert_wc_noindex_defaults_seo_bar( $interpreter ) {
if ( $interpreter::$query['taxonomy'] ) return;
static $page_ids;
if ( ! isset( $page_ids ) )
$page_ids = array_filter( [ \wc_get_page_id( 'cart' ), \wc_get_page_id( 'checkout' ), \wc_get_page_id( 'myaccount' ) ] );
if ( ! \in_array( $interpreter::$query['id'], $page_ids, true ) ) return;
$items = $interpreter::collect_seo_bar_items();
// Don't do anything if there's a blocking redirect.
if ( ! empty( $items['redirect']['meta']['blocking'] ) ) return;
$index_item = &$interpreter::edit_seo_bar_item( 'indexing' );
$index_item['status'] =
0 !== \tsf()->s_qubit(
\The_SEO_Framework\Builders\SEOBar\Page::get_instance()->get_query_cache()['meta']['_genesis_noindex']
)
? $interpreter::STATE_OKAY
: $interpreter::STATE_UNKNOWN;
$index_item['assess']['recommends'] = \__( 'WooCommerce recommends not indexing this dynamic page.', 'autodescription' );
}
\add_filter( 'the_seo_framework_image_generation_params', __NAMESPACE__ . '\\_adjust_wc_image_generation_params', 10, 2 );
/**
* Adjusts image generation parameters.
*
* @since 4.0.5 (introduced @ 4.0.0, renamed to prevent conflict).
* @since 4.2.0 Now supports the `$args['pta']` index.
* @access private
*
* @param array $params : [
* string size: The image size to use.
* boolean multi: Whether to allow multiple images to be returned.
* array cbs: The callbacks to parse. Ideally be generators, so we can halt remotely.
* array fallback: The callbacks to parse. Ideally be generators, so we can halt remotely.
* ];
* @param array|null $args The query arguments. Contains 'id', 'taxonomy', and 'pta'.
* Is null when query is autodetermined.
* @return array $params
*/
function _adjust_wc_image_generation_params( $params, $args ) {
$is_product = false;
$is_product_category = false;
if ( null === $args ) {
$is_product = \tsf()->is_product();
$is_product_category = \function_exists( '\\is_product_category' ) && \is_product_category();
} else {
if ( $args['taxonomy'] ) {
if ( \function_exists( '\\is_product_category' ) ) {
$term = \get_term( $args['id'], $args['taxonomy'] );
$is_product_category = $term && \is_product_category( $term );
}
} elseif ( $args['pta'] ) { // phpcs:ignore, Generic.CodeAnalysis.EmptyStatement.DetectedElseif
// TODO ? Which public non-page-PTA does WC have, actually?
} else {
$is_product = \tsf()->is_product( $args['id'] );
}
}
if ( $is_product ) {
$params['cbs']['wc_gallery'] = __NAMESPACE__ . '\\_get_product_gallery_image_details';
}
if ( $is_product_category ) {
$params['cbs']['wc_thumbnail'] = __NAMESPACE__ . '\\_get_product_category_thumbnail_image_details';
}
return $params;
}
/**
* Generates image URLs and IDs from the WooCommerce product gallary entries.
*
* @since 4.0.0
* @since 4.2.0 Now supports the `$args['pta']` index.
* @access private
* @generator
*
* @param array|null $args The query arguments. Accepts 'id', 'taxonomy', and 'pta'.
* Leave null to autodetermine query.
* @param string $size The size of the image to get.
* @yield array : {
* string url: The image URL location,
* int id: The image ID,
* }
*/
function _get_product_gallery_image_details( $args = null, $size = 'full' ) {
$post_id = $args['id'] ?? \tsf()->get_the_real_ID();
$attachment_ids = [];
if ( $post_id && \metadata_exists( 'post', $post_id, '_product_image_gallery' ) ) {
$attachment_ids = array_map(
'absint',
array_filter(
explode(
',',
\get_post_meta( $post_id, '_product_image_gallery', true )
)
)
);
}
if ( $attachment_ids ) {
foreach ( $attachment_ids as $id ) {
yield [
'url' => \wp_get_attachment_image_url( $id, $size ),
'id' => $id,
];
}
} else {
yield [
'url' => '',
'id' => 0,
];
}
}
/**
* Generates image URL and ID from the WooCommerce product category thumbnail entries.
*
* @since 4.0.0
* @access private
* @generator
*
* @param array|null $args The query arguments. Accepts 'id', 'taxonomy', and 'pta'.
* Leave null to autodetermine query.
* @param string $size The size of the image to get.
* @yield array : {
* string url: The image URL location,
* int id: The image ID,
* }
*/
function _get_product_category_thumbnail_image_details( $args = null, $size = 'full' ) {
$term_id = $args['id'] ?? \tsf()->get_the_real_ID();
$thumbnail_id = \get_term_meta( $term_id, 'thumbnail_id', true ) ?: 0;
if ( $thumbnail_id ) {
yield [
'url' => \wp_get_attachment_image_url( $thumbnail_id, $size ) ?: '',
'id' => $thumbnail_id,
];
} else {
yield [
'url' => '',
'id' => 0,
];
}
}
Zerion Mini Shell 1.0