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 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 
<?php
namespace WPGraphQL\Type\Taxonomy;

use GraphQL\Type\Definition\ResolveInfo;
use GraphQLRelay\Relay;
use WPGraphQL\AppContext;
use WPGraphQL\Type\WPObjectType;
use WPGraphQL\Types;

/**
 * Class TaxonomyType
 * @package WPGraphQL\Type
 * @since 0.0.5
 */
class TaxonomyType extends WPObjectType {

    /**
     * Holds the type name
     * @var string $type_name
     */
    private static $type_name;

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

    /**
     * TaxonomyType constructor.
     * @since 0.0.5
     */
    public function __construct() {

        /**
         * Set the type_name
         * @since 0.0.5
         */
        self::$type_name = 'Taxonomy';

        $config = [
            'name' => self::$type_name,
            'description' => __( 'A taxonomy object', 'wp-graphql' ),
            'fields' => self::fields(),
            'interfaces' => [ self::node_interface() ],
        ];

        parent::__construct( $config );

    }

    /**
     * fields
     *
     * This defines the fields for the TaxonomyType. The fields are passed through a filter so the shape of the schema
     * can be modified
     *
     * @return array|\GraphQL\Type\Definition\FieldDefinition[]
     * @since 0.0.5
     */
    private function fields() {

        if ( null === self::$fields ) :
            /**
             * Get the post_types that are allowed in WPGraphQL
             * @since 0.0.6
             */
            $allowed_post_types = \WPGraphQL::$allowed_post_types;

            self::$fields = function() use ( $allowed_post_types ) {
                $fields = [
                    'id' => [
                        'type' => Types::non_null( Types::id() ),
                        'resolve' => function( $taxonomy, $args, AppContext $context, ResolveInfo $info ) {
                            return ( ! empty( $info->parentType ) && ! empty( $taxonomy->name ) ) ? Relay::toGlobalId( 'taxonomy', $taxonomy->name ) : null;
                        },
                    ],
                    'name' => [
                        'type' => Types::string(),
                        'description' => __( 'The display name of the taxonomy. This field is equivalent to WP_Taxonomy->label', 'wp-graphql' ),
                    ],
                    'label' => [
                        'type' => Types::string(),
                        'description' => __( 'Name of the taxonomy shown in the menu. Usually plural.', 'wp-graphql' ),
                    ],
                    //@todo: add "labels" field
                    'description' => [
                        'type' => Types::string(),
                        'description' => __( 'Description of the taxonomy. This field is equivalent to WP_Taxonomy->description', 'wp-graphql' ),
                    ],
                    'public' => [
                        'type' => Types::boolean(),
                        'description' => __( 'Whether the taxonomy is publicly queryable', 'wp-graphql' ),
                    ],
                    'hierarchical' => [
                        'type' => Types::boolean(),
                        'description' => __( 'Whether the taxonomy is hierarchical', 'wp-graphql' ),
                    ],
                    'showUi' => [
                        'type' => Types::boolean(),
                        'description' => __( 'Whether to generate and allow a UI for managing terms in this taxonomy in the admin', 'wp-graphql' ),
                        'resolve' => function( \WP_Taxonomy $taxonomy, array $args, AppContext $context, ResolveInfo $info ) {
                            return ( true === $taxonomy->show_ui ) ? true : false;
                        },
                    ],
                    'showInMenu' => [
                        'type' => Types::boolean(),
                        'description' => __( 'Whether to show the taxonomy in the admin menu', 'wp-graphql' ),
                        'resolve' => function( \WP_Taxonomy $taxonomy, array $args, AppContext $context, ResolveInfo $info ) {
                            return ( true === $taxonomy->show_in_menu ) ? true : false;
                        },
                    ],
                    'showInNavMenus' => [
                        'type' => Types::boolean(),
                        'description' => __( 'Whether the taxonomy is available for selection in navigation menus.', 'wp-graphql' ),
                        'resolve' => function( \WP_Taxonomy $taxonomy, array $args, AppContext $context, ResolveInfo $info ) {
                            return ( true === $taxonomy->show_in_nav_menus ) ? true : false;
                        },
                    ],
                    'showCloud' => [
                        'type' => Types::boolean(),
                        'description' => __( 'Whether to show the taxonomy as part of a tag cloud widget. This field is equivalent to WP_Taxonomy->show_tagcloud', 'wp-graphql' ),
                        'resolve' => function( \WP_Taxonomy $taxonomy, array $args, AppContext $context, ResolveInfo $info ) {
                            return ( true === $taxonomy->show_tagcloud ) ? true : false;
                        },
                    ],
                    'showInQuickEdit' => [
                        'type' => Types::boolean(),
                        'description' => __( 'Whether to show the taxonomy in the quick/bulk edit panel.', 'wp-graphql' ),
                        'resolve' => function( \WP_Taxonomy $taxonomy, array $args, AppContext $context, ResolveInfo $info ) {
                            return ( true === $taxonomy->show_in_quick_edit ) ? true : false;
                        },
                    ],
                    'showInAdminColumn' => [
                        'type' => Types::boolean(),
                        'description' => __( 'Whether to display a column for the taxonomy on its post type listing screens.', 'wp-graphql' ),
                        'resolve' => function( \WP_Taxonomy $taxonomy, array $args, AppContext $context, ResolveInfo $info ) {
                            return ( true === $taxonomy->show_admin_column ) ? true : false;
                        },
                    ],
                    'showInRest' => [
                        'type' => Types::boolean(),
                        'description' => __( 'Whether to add the post type route in the REST API `wp/v2` namespace.', 'wp-graphql' ),
                        'resolve' => function( \WP_Taxonomy $taxonomy, array $args, AppContext $context, ResolveInfo $info ) {
                            return ( true === $taxonomy->show_in_rest ) ? true : false;
                        },
                    ],
                    'restBase' => [
                        'type' => Types::string(),
                        'description' => __( 'Name of content type to diplay in REST API `wp/v2` namespace.', 'wp-graphql' ),
                        'resolve' => function( \WP_Taxonomy $taxonomy, array $args, AppContext $context, ResolveInfo $info ) {
                            return ! empty( $taxonomy->rest_base ) ? $taxonomy->rest_base : null;
                        },
                    ],
                    'restControllerClass' => [
                        'type' => Types::string(),
                        'description' => __( 'The REST Controller class assigned to handling this content type.', 'wp-graphql' ),
                        'resolve' => function( \WP_Taxonomy $taxonomy, array $args, AppContext $context, ResolveInfo $info ) {
                            return ! empty( $taxonomy->rest_controller_class ) ? $taxonomy->rest_controller_class : null;
                        },
                    ],
                    'showInGraphql' => [
                        'type' => Types::boolean(),
                        'description' => __( 'Whether to add the post type to the GraphQL Schema.', 'wp-graphql' ),
                        'resolve' => function( \WP_Taxonomy $taxonomy, array $args, AppContext $context, ResolveInfo $info ) {
                            return ( true === $taxonomy->show_in_graphql ) ? true : false;
                        },
                    ],
                    'graphqlSingleName' => [
                        'type' => Types::string(),
                        'description' => __( 'The singular name of the post type within the GraphQL Schema.', 'wp-graphql' ),
                        'resolve' => function( \WP_Taxonomy $taxonomy, array $args, AppContext $context, ResolveInfo $info ) {
                            return ! empty( $taxonomy->graphql_single_name ) ? $taxonomy->graphql_single_name : null;
                        },
                    ],
                    'graphqlPluralName' => [
                        'type' => Types::string(),
                        'description' => __( 'The plural name of the post type within the GraphQL Schema.', 'wp-graphql' ),
                        'resolve' => function( \WP_Taxonomy $taxonomy, array $args, AppContext $context, ResolveInfo $info ) {
                            return ! empty( $taxonomy->graphql_plural_name ) ? $taxonomy->graphql_plural_name : null;
                        },
                    ],
                    'connectedPostTypeNames' => [
                        'type' => Types::list_of( Types::string() ),
                        'args' => [
                            'types' => [
                                'type' => Types::list_of( Types::post_type_enum() ),
                                'description' => __( 'Select which post types to limit the results to', 'wp-graphql' ),
                            ],
                        ],
                        'description' => __( 'A list of Post Types associated with the taxonomy', 'wp-graphql' ),
                        'resolve' => function( \WP_Taxonomy $taxonomy, array $args, AppContext $context, ResolveInfo $info ) use ( $allowed_post_types ) {
                            $post_type_names = [];

                            /**
                             * If the types $arg is populated, use that to filter the $allowed_post_types,
                             * otherwise use the default $allowed_post_types passed down
                             */
                            $allowed_post_types = ! empty( $args['types'] ) && is_array( $args['types'] ) ? $args['types'] : $allowed_post_types;

                            $connected_post_types = $taxonomy->object_type;
                            if ( ! empty( $connected_post_types ) && is_array( $connected_post_types ) ) {
                                foreach ( $connected_post_types as $post_type ) {
                                    if ( in_array( $post_type, $allowed_post_types, true ) ) {
                                        $post_type_names[] = $post_type;
                                    }
                                }
                            }
                            return ! empty( $post_type_names ) ? $post_type_names : null;
                        },
                    ],
                    'connectedPostTypes' => [
                        'type' => Types::list_of( Types::post_type() ),
                        'args' => [
                            'types' => [
                                'type' => Types::list_of( Types::post_type_enum() ),
                                'description' => __( 'Select which post types to limit the results to', 'wp-graphql' ),
                            ],
                        ],
                        'description' => __( 'List of Post Types connected to the Taxonomy', 'wp-graphql' ),
                        'resolve' => function( \WP_Taxonomy $taxonomy, array $args, AppContext $context, ResolveInfo $info ) use ( $allowed_post_types ) {

                            $post_type_objects = [];

                            /**
                             * If the types $arg is populated, use that to filter the $allowed_post_types,
                             * otherwise use the default $allowed_post_types passed down
                             */
                            $allowed_post_types = ! empty( $args['types'] ) && is_array( $args['types'] ) ? $args['types'] : $allowed_post_types;

                            $connected_post_types = ! empty( $taxonomy->object_type ) ? $taxonomy->object_type : [];
                            if ( ! empty( $allowed_post_types ) && is_array( $allowed_post_types ) ) {
                                foreach ( $allowed_post_types as $post_type ) {
                                    if ( in_array( $post_type, $connected_post_types, true ) ) {
                                        $post_type_object = get_post_type_object( $post_type );
                                        $post_type_objects[ $post_type_object->graphql_single_name ] = $post_type_object;
                                    }
                                }
                            }
                            return ! empty( $post_type_objects ) ? $post_type_objects : null;
                        },
                    ],
                ];

                /**
                 * This prepares the fields by sorting them and applying a filter for adjusting the schema.
                 * Because these fields are implemented via a closure the prepare_fields needs to be applied
                 * to the fields directly instead of being applied to all objects extending
                 * the WPObjectType class.
                 */
                return self::prepare_fields( $fields, self::$type_name );

            };
        endif;
        return self::$fields;

    }
}
API documentation generated by ApiGen