Query Hooks

Wordpress hooks related to the QueryBuilder class.

Filter: query_builder_get_builder

Triggered when the get() method is called (Read wiki), before the database query is built.

Parameter	Type	Description
$builder	TenQuality\WP\Database\QueryBuilder	Builder class.

Returns: TenQuality\WP\Database\QueryBuilder the builder instance is expected to be returned back.

Versions

• query_builder_get_builder

add_filter( 'query_builder_get_builder', function( $builder ) {
   // Force and limit every get result to 25 records
   $builder->limit( 25 );
   return $builder;
} ); 

• query_builder_get_builder_{$query_id}

This second version has the query ID as a suffix, allowing for a specific hook to be used, see an example:

$builder = QueryBuilder::create( 'my_custom_id' );

add_filter( 'query_builder_get_builder_my_custom_id', function( $builder ) {
   // Force and limit on 'my_custom_id' results
   $builder->limit( 25 );
   return $builder;
} ); 

---

Filter: query_builder_get_query

Triggered when the get() method is called (Read wiki), after the builder generated a SQL query (string) and before it is executed against the database.

Parameter	Type	Description
$query	string	SQL query script.

Returns: string the query (string) is expected to be returned back.

Versions

• query_builder_get_query
• query_builder_get_query_{$query_id}

add_filter( 'query_builder_get_query', function( $query) {
   echo $query;
   return $query;
} ); 

---

Filter: query_builder_first_builder

Triggered when the first() method is called (Read wiki), before the database query is built.

Parameter	Type	Description
$builder	TenQuality\WP\Database\QueryBuilder	Builder class.

Returns: TenQuality\WP\Database\QueryBuilder the builder instance is expected to be returned back.

Versions

• query_builder_first_builder
• query_builder_first_builder_{$query_id}

---

Filter: query_builder_first_query

Triggered when the first() method is called (Read wiki), after the builder generated a SQL query (string) and before it is executed against the database.

Parameter	Type	Description
$query	string	SQL query script.

Returns: string the query (string) is expected to be returned back.

Versions

• query_builder_first_query
• query_builder_first_query_{$query_id}

---

Filter: query_builder_value_builder

Triggered when the value() method is called (Read wiki), before the database query is built.

Parameter	Type	Description
$builder	TenQuality\WP\Database\QueryBuilder	Builder class.

Returns: TenQuality\WP\Database\QueryBuilder the builder instance is expected to be returned back.

Versions

• query_builder_value_builder
• query_builder_value_builder_{$query_id}

---

Filter: query_builder_value_query

Triggered when the value() method is called (Read wiki), after the builder generated a SQL query (string) and before it is executed against the database.

Parameter	Type	Description
$query	string	SQL query script.

Returns: string the query (string) is expected to be returned back.

Versions

• query_builder_value_query
• query_builder_value_query_{$query_id}

---

Filter: query_builder_count_builder

Triggered when the count() method is called (Read wiki), before the database query is built.

Parameter	Type	Description
$builder	TenQuality\WP\Database\QueryBuilder	Builder class.

Returns: TenQuality\WP\Database\QueryBuilder the builder instance is expected to be returned back.

Versions

• query_builder_count_builder
• query_builder_count_builder_{$query_id}

---

Filter: query_builder_count_query

Triggered when the count() method is called (Read wiki), after the builder generated a SQL query (string) and before it is executed against the database.

Parameter	Type	Description
$query	string	SQL query script.

Returns: string the query (string) is expected to be returned back.

Versions

• query_builder_count_query
• query_builder_count_query_{$query_id}