woocommerce_docs_url

Show row meta on the plugin screen.

Description

(array) apply_filters( 'woocommerce_docs_url', (string) $https_docs_woocommerce_com_documentation_plugins_woocommerce ); 

Returns (array)

Parameters (1)

0. $https_docs_woocommerce_com_documentation_plugins_woocommerce (string) => 'https://docs.woocommerce.com/documentation/plugins/woocommerce/'
The https docs woocommerce com documentation plugins woocommerce.

Usage

To run the hook, copy the example below.
  1. $https_docs_woocommerce_com_documentation_plugins_woocommerce = apply_filters( 'woocommerce_docs_url', $https_docs_woocommerce_com_documentation_plugins_woocommerce ); 
  2.  
  3. if ( !empty( $https_docs_woocommerce_com_documentation_plugins_woocommerce ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the woocommerce_docs_url callback 
  2. function filter_woocommerce_docs_url( $https_docs_woocommerce_com_documentation_plugins_woocommerce ) { 
  3. // make filter magic happen here... 
  4. return $https_docs_woocommerce_com_documentation_plugins_woocommerce
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'woocommerce_docs_url', 'filter_woocommerce_docs_url', 10, 1 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'woocommerce_docs_url', 'filter_woocommerce_docs_url', 10, 1 ); 

Defined (4)

The filter is defined in the following location(s).

/includes/class-wc-install.php  
  1. 'docs' => '<a href="' . esc_url( apply_filters( 'woocommerce_docs_url', 'https://docs.woocommerce.com/documentation/plugins/woocommerce/' ) ) . '" aria-label="' . esc_attr__( 'View WooCommerce documentation', 'woocommerce' ) . '">' . esc_html__( 'Docs', 'woocommerce' ) . '</a>', 
/includes/admin/views/html-notice-theme-support.php  
  1. <p><?php printf( __( '<strong>Your theme does not declare WooCommerce support</strong> – Please read our <a href="%1$s" target="_blank">integration</a> guide or check out our <a href="%2$s" target="_blank">Storefront</a> theme which is totally free to download and designed specifically for use with WooCommerce.', 'woocommerce' ), esc_url( apply_filters( 'woocommerce_docs_url', 'https://docs.woocommerce.com/document/third-party-custom-theme-compatibility/', 'theme-compatibility' ) ), esc_url( admin_url( 'theme-install.php?theme=storefront' ) ) ); ?></p> 
  1. <a href="<?php echo esc_url( apply_filters( 'woocommerce_docs_url', 'http://docs.woocommerce.com/document/third-party-custom-theme-compatibility/?utm_source=notice&utm_medium=product&utm_content=themecompatibility&utm_campaign=woocommerceplugin' ) ); ?>" class="button-secondary" target="_blank"><?php _e( 'Theme integration guide', 'woocommerce' ); ?></a> 
/includes/admin/meta-boxes/views/html-product-data-variations.php  
  1. <p><a class="button-primary" href="<?php echo esc_url( apply_filters( 'woocommerce_docs_url', 'https://docs.woocommerce.com/document/variable-product/', 'product-variations' ) ); ?>" target="_blank"><?php _e( 'Learn more', 'woocommerce' ); ?></a></p>