get_terms_defaults

Filter Hook

Description

Filters the terms query default arguments. Use {@see 'get_terms_args'} to filter the passed arguments.

Hook Information

File Location	`wp-includes/class-wp-term-query.php` View on GitHub
Hook Type	Filter
Line Number	`260`

Hook Parameters

Type	Name	Description
`array`	`$defaults`	An array of default get_terms() arguments.
`string[]`	`$taxonomies`	An array of taxonomy names.

Usage Examples

Basic Usage

<?php
// Hook into get_terms_defaults
add_filter('get_terms_defaults', 'my_custom_filter', 10, 2);

function my_custom_filter($defaults, $taxonomies) {
    // Your custom filtering logic here
    return $defaults;
}

Source Code Context

wp-includes/class-wp-term-query.php:260 - How this hook is used in WordPress core

<?php
 255  		 * @since 4.4.0
 256  		 *
 257  		 * @param array    $defaults   An array of default get_terms() arguments.
 258  		 * @param string[] $taxonomies An array of taxonomy names.
 259  		 */
 260  		$this->query_var_defaults = apply_filters( 'get_terms_defaults', $this->query_var_defaults, $taxonomies );
 261  
 262  		$query = wp_parse_args( $query, $this->query_var_defaults );
 263  
 264  		$query['number'] = absint( $query['number'] );
 265  		$query['offset'] = absint( $query['offset'] );

PHP Documentation

<?php
/**
		 * Filters the terms query default arguments.
		 *
		 * Use {@see 'get_terms_args'} to filter the passed arguments.
		 *
		 * @since 4.4.0
		 *
		 * @param array    $defaults   An array of default get_terms() arguments.
		 * @param string[] $taxonomies An array of taxonomy names.
		 */

Quick Info

Hook Type: Filter
Parameters: 2
File: wp-includes/class-wp-term-query.php

Links

WordPress Docs View Source Code Search Examples

Related Hooks

Related hooks will be displayed here in future updates.