Overview
  • Namespace
  • Class

Namespaces

  • WPGraphQL
    • Data
    • Type
      • Avatar
      • Comment
        • Connection
      • CommentAuthor
      • EditLock
      • Enum
      • MediaItem
        • Mutation
      • Plugin
        • Connection
      • PostObject
        • Connection
        • Mutation
      • PostType
      • Setting
      • Taxonomy
      • TermObject
        • Connection
        • Mutation
      • Theme
        • Connection
      • Union
      • User
        • Connection
        • Mutation
    • Utils

Classes

  • WPGraphQL\AppContext
  • WPGraphQL\Data\Config
  • WPGraphQL\Data\ConnectionResolver
  • WPGraphQL\Data\DataSource
  • WPGraphQL\Data\Loader
  • WPGraphQL\Router
  • WPGraphQL\Type\Avatar\AvatarType
  • WPGraphQL\Type\Comment\CommentQuery
  • WPGraphQL\Type\Comment\CommentType
  • WPGraphQL\Type\Comment\Connection\CommentConnectionArgs
  • WPGraphQL\Type\Comment\Connection\CommentConnectionDefinition
  • WPGraphQL\Type\Comment\Connection\CommentConnectionResolver
  • WPGraphQL\Type\CommentAuthor\CommentAuthorQuery
  • WPGraphQL\Type\CommentAuthor\CommentAuthorType
  • WPGraphQL\Type\EditLock\EditLockType
  • WPGraphQL\Type\Enum\MediaItemStatusEnumType
  • WPGraphQL\Type\Enum\MimeTypeEnumType
  • WPGraphQL\Type\Enum\PostObjectFieldFormatEnumType
  • WPGraphQL\Type\Enum\PostStatusEnumType
  • WPGraphQL\Type\Enum\PostTypeEnumType
  • WPGraphQL\Type\Enum\RelationEnumType
  • WPGraphQL\Type\Enum\TaxonomyEnumType
  • WPGraphQL\Type\MediaItem\MediaItemType
  • WPGraphQL\Type\MediaItem\Mutation\MediaItemCreate
  • WPGraphQL\Type\MediaItem\Mutation\MediaItemDelete
  • WPGraphQL\Type\MediaItem\Mutation\MediaItemMutation
  • WPGraphQL\Type\MediaItem\Mutation\MediaItemUpdate
  • WPGraphQL\Type\Plugin\Connection\PluginConnectionDefinition
  • WPGraphQL\Type\Plugin\Connection\PluginConnectionResolver
  • WPGraphQL\Type\Plugin\PluginQuery
  • WPGraphQL\Type\Plugin\PluginType
  • WPGraphQL\Type\PostObject\Connection\PostObjectConnectionArgs
  • WPGraphQL\Type\PostObject\Connection\PostObjectConnectionArgsDateQuery
  • WPGraphQL\Type\PostObject\Connection\PostObjectConnectionDefinition
  • WPGraphQL\Type\PostObject\Connection\PostObjectConnectionResolver
  • WPGraphQL\Type\PostObject\Mutation\PostObjectCreate
  • WPGraphQL\Type\PostObject\Mutation\PostObjectDelete
  • WPGraphQL\Type\PostObject\Mutation\PostObjectMutation
  • WPGraphQL\Type\PostObject\Mutation\PostObjectUpdate
  • WPGraphQL\Type\PostObject\Mutation\TermObjectDelete
  • WPGraphQL\Type\PostObject\PostObjectQuery
  • WPGraphQL\Type\PostObject\PostObjectType
  • WPGraphQL\Type\PostType\PostTypeType
  • WPGraphQL\Type\RootMutationType
  • WPGraphQL\Type\RootQueryType
  • WPGraphQL\Type\Setting\SettingQuery
  • WPGraphQL\Type\Setting\SettingType
  • WPGraphQL\Type\Taxonomy\TaxonomyType
  • WPGraphQL\Type\TermObject\Connection\TermObjectConnectionArgs
  • WPGraphQL\Type\TermObject\Connection\TermObjectConnectionDefinition
  • WPGraphQL\Type\TermObject\Connection\TermObjectConnectionResolver
  • WPGraphQL\Type\TermObject\Mutation\TermObjectCreate
  • WPGraphQL\Type\TermObject\Mutation\TermObjectMutation
  • WPGraphQL\Type\TermObject\Mutation\TermObjectUpdate
  • WPGraphQL\Type\TermObject\TermObjectQuery
  • WPGraphQL\Type\TermObject\TermObjectType
  • WPGraphQL\Type\Theme\Connection\ThemeConnectionDefinition
  • WPGraphQL\Type\Theme\Connection\ThemeConnectionResolver
  • WPGraphQL\Type\Theme\ThemeType
  • WPGraphQL\Type\Union\CommentAuthorUnionType
  • WPGraphQL\Type\Union\PostObjectUnionType
  • WPGraphQL\Type\Union\TermObjectUnionType
  • WPGraphQL\Type\User\Connection\UserConnectionArgs
  • WPGraphQL\Type\User\Connection\UserConnectionDefinition
  • WPGraphQL\Type\User\Connection\UserConnectionResolver
  • WPGraphQL\Type\User\Mutation\UserCreate
  • WPGraphQL\Type\User\Mutation\UserDelete
  • WPGraphQL\Type\User\Mutation\UserMutation
  • WPGraphQL\Type\User\Mutation\UserUpdate
  • WPGraphQL\Type\User\UserQuery
  • WPGraphQL\Type\User\UserType
  • WPGraphQL\Type\WPEnumType
  • WPGraphQL\Type\WPInputObjectType
  • WPGraphQL\Type\WPObjectType
  • WPGraphQL\Types
  • WPGraphQL\Utils\InstrumentSchema
  • WPGraphQL\WPSchema

Interfaces

  • WPGraphQL\Data\ConnectionResolverInterface
  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 
<?php
namespace WPGraphQL\Type\TermObject\Connection;

use WPGraphQL\Type\WPEnumType;
use WPGraphQL\Type\WPInputObjectType;
use WPGraphQL\Types;

/**
 * Class TermObjectConnectionArgs
 *
 * This sets up the Query Args for term object connections, which uses get_terms, so this defines the allowed
 * input fields that will be passed to get_terms
 *
 * @package WPGraphQL\Type
 * @since 0.0.5
 */
class TermObjectConnectionArgs extends WPInputObjectType {

    /**
     * This holds the field definitions
     * @var array $fields
     * @since 0.0.5
     */
    public static $fields;

    /**
     * TermObjectConnectionArgs constructor.
     * @since 0.0.5
     */
    public function __construct( $config = [] ) {
        $config['name'] = 'TermArgs';
        $config['fields'] = self::fields();
        parent::__construct( $config );
    }

    /**
     * fields
     *
     * This defines the fields that make up the TermObjectConnectionArgs
     *
     * @return array
     * @since 0.0.5
     */
    private static function fields() {

        if ( null === self::$fields ) :
            self::$fields = [
                'objectIds' => [
                    'type' => Types::list_of( Types::int() ),
                    'description' => __( 'Array of object IDs. Results will be limited to terms associated with these objects.', 'wp-graphql' ),
                ],
                'orderby' => [
                    'type' => new WPEnumType( [
                        'name' => 'TermsOrderby',
                        'values' => [
                            'NAME' => [
                                'value' => 'name',
                            ],
                            'SLUG' => [
                                'value' => 'slug',
                            ],
                            'TERM_GROUP' => [
                                'value' => 'term_group',
                            ],
                            'TERM_ID' => [
                                'value' => 'term_id',
                            ],
                            'DESCRIPTION' => [
                                'value' => 'description',
                            ],
                            'COUNT' => [
                                'value' => 'count',
                            ],
                        ],
                    ] ),
                    'description' => __( 'Field(s) to order terms by. Defaults to \'name\'.', 'wp-graphql' ),
                ],
                'hideEmpty' => [
                    'type' => Types::boolean(),
                    'description' => __( 'Whether to hide terms not assigned to any posts. Accepts true or false. Default true', 'wp-graphql' ),
                ],
                'include' => [
                    'type' => Types::list_of( Types::int() ),
                    'description' => __( 'Array of term ids to include. Default empty array.', 'wp-graphql' ),
                ],
                'exclude' => [
                    'type' => Types::list_of( Types::int() ),
                    'description' => __( 'Array of term ids to exclude. If $include is non-empty, $exclude is ignored. Default empty array.', 'wp-graphql' ),
                ],
                'excludeTree' => [
                    'type' => Types::list_of( Types::int() ),
                    'description' => __( 'Array of term ids to exclude along with all of their descendant terms. If $include is non-empty, $exclude_tree is ignored. Default empty array.', 'wp-graphql' ),
                ],
                'name' => [
                    'type' => Types::list_of( Types::string() ),
                    'description' => __( 'Array of names to return term(s) for. Default empty.', 'wp-graphql' ),
                ],
                'slug' => [
                    'type' => Types::list_of( Types::string() ),
                    'description' => __( 'Array of slugs to return term(s) for. Default empty.', 'wp-graphql' ),
                ],
                'termTaxonomId' => [
                    'type' => Types::list_of( Types::int() ),
                    'description' => __( 'Array of term taxonomy IDs, to match when querying terms.', 'wp-graphql' ),
                ],
                'hierarchical' => [
                    'type' => Types::boolean(),
                    'description' => __( 'Whether to include terms that have non-empty descendants (even if $hide_empty is set to true). Default true.', 'wp-graphql' ),
                ],
                'search' => [
                    'type' => Types::string(),
                    'description' => __( 'Search criteria to match terms. Will be SQL-formatted with wildcards before and after. Default empty.', 'wp-graphql' ),
                ],
                'nameLike' => [
                    'type' => Types::string(),
                    'description' => __( 'Retrieve terms with criteria by which a term is LIKE `$name__like`. Default empty.', 'wp-graphql' ),
                ],
                'descriptionLike' => [
                    'type' => Types::string(),
                    'description' => __( 'Retrieve terms where the description is LIKE `$description__like`. Default empty.', 'wp-graphql' ),
                ],
                'padCounts' => [
                    'type' => Types::boolean(),
                    'description' => __( 'Whether to pad the quantity of a term\'s children in the quantity of each term\'s "count" object variable. Default false.', 'wp-graphql' ),
                ],
                'childOf' => [
                    'type' => Types::int(),
                    'description' => __( 'Term ID to retrieve child terms of. If multiple taxonomies are passed, $child_of is ignored. Default 0.', 'wp-graphql' ),
                ],
                'parent' => [
                    'type' => Types::int(),
                    'description' => __( 'Parent term ID to retrieve direct-child terms of. Default empty.', 'wp-graphql' ),
                ],
                'childless' => [
                    'type' => Types::boolean(),
                    'description' => __( 'True to limit results to terms that have no children. This parameter has no effect on non-hierarchical taxonomies. Default false.', 'wp-graphql' ),
                ],
                'cacheDomain' => [
                    'type' => Types::string(),
                    'description' => __( 'Unique cache key to be produced when this query is stored in an object cache. Default is \'core\'.', 'wp-graphql' ),
                ],
                'updateTermMetaCache' => [
                    'type' => Types::boolean(),
                    'description' => __( 'Whether to prime meta caches for matched terms. Default true.', 'wp-graphql' ),
                ],
            ];
        endif;
        return self::prepare_fields( self::$fields, 'TermArgs' );
    }

}
API documentation generated by ApiGen