acf/fields/relationship/query

Documentation Filters acf/fields/relationship/query

Last updated Feb 17, 2022

Description

Filters the query $args used by WP_Query to display posts in the Relationship field.

Changelog

• Added in version 4.1.2

Parameters

apply_filters( 'acf/fields/relationship/query', $args, $field, $post_id );

• $args (array) The query args. See WP_Query for available args.
• $field (array) The field array containing all settings.
• $post_id (int|string) The current post ID being edited.

Modifers

This filter provides modifiers to target specific fields. The following filter names are available:

• acf/fields/relationship/query Applies to all fields.
• acf/fields/relationship/query/name={$name} Applies to all fields of a specific name.
• acf/fields/relationship/query/key={$key} Applies to all fields of a specific key.

Example

This example demonstrates how to modify some of the Relationship field query args.

functions.php

<?php
add_filter('acf/fields/relationship/query', 'my_acf_fields_relationship_query', 10, 3);
function my_acf_fields_relationship_query( $args, $field, $post_id ) {

    // Show 40 posts per AJAX call.
    $args['posts_per_page'] = 40;

    // Restrict results to children of the current post only.
    $args['post_parent'] = $post_id;

    return $args;
}

Related

• Field Types: Relationship
• Filters: acf/fields/relationship/result