woocommerce_apidocs_url

The WooCommerce woocommerce apidocs url hook.

Description

apply_filters( 'woocommerce_apidocs_url', (string) $https_docs_woocommerce_com_wc_apidocs ); 

Parameters (1)

0. $https_docs_woocommerce_com_wc_apidocs (string) => 'https://docs.woocommerce.com/wc-apidocs/'
The https docs woocommerce com wc apidocs.

Usage

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

Defined (1)

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

/includes/class-wc-install.php  
  1. 'apidocs' => '<a href="' . esc_url( apply_filters( 'woocommerce_apidocs_url', 'https://docs.woocommerce.com/wc-apidocs/' ) ) . '" aria-label="' . esc_attr__( 'View WooCommerce API docs', 'woocommerce' ) . '">' . esc_html__( 'API docs', 'woocommerce' ) . '</a>',