<prefix>custom_<sitemap_type>
The All In One SEO Pack prefix custom sitemap type hook.
Description
apply_filters( '<prefix>custom_<sitemap_type>', (unknown) $sitemap_data, (unknown) $page, (unknown) $this_options );
Parameters (3)
- 0. $sitemap_data (unknown)
- The sitemap data.
- 1. $page (unknown)
- The page.
- 2. $this_options (unknown)
- The this options.
Usage
- To run the hook, copy the example below.
- $sitemap_data = apply_filters( '{$prefix}custom_{$sitemap_type}', $sitemap_data, $page, $this_options );
- if ( !empty( $sitemap_data ) ) {
- // everything has led up to this point...
- }
- The following example is for adding a hook callback.
- // define the <prefix>custom_<sitemap_type> callback
- function filter_prefixcustom_sitemap_type( $sitemap_data, $page, $this_options ) {
- // make filter magic happen here...
- return $sitemap_data;
- };
- // add the filter
- add_filter( "{$prefix}custom_{$sitemap_type}", 'filter_prefixcustom_sitemap_type', 10, 3 );
- To remove a hook callback, use the example below.
- // remove the filter
- remove_filter( "{$prefix}custom_{$sitemap_type}", 'filter_prefixcustom_sitemap_type', 10, 3 );
Defined (2)
The filter is defined in the following location(s).
- /modules/aioseop_sitemap.php
- $sitemap_data = apply_filters( $this->prefix . 'custom_' . $sitemap_type, $sitemap_data, $page, $this_options );
- $sitemap_data = apply_filters( $this->prefix . 'custom_' . $sitemap_type, $sitemap_data, $page, $this_options );