File Type/TermObject/TermObjectType.php

  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

<?php

namespace WPGraphQL\Type\TermObject;

use GraphQL\Type\Definition\ResolveInfo;
use GraphQLRelay\Relay;
use WPGraphQL\AppContext;
use WPGraphQL\Data\DataSource;
use WPGraphQL\Type\PostObject\Connection\PostObjectConnectionDefinition;
use WPGraphQL\Type\TermObject\Connection\TermObjectConnectionDefinition;
use WPGraphQL\Type\TermObject\Connection\TermObjectConnectionResolver;
use WPGraphQL\Type\WPObjectType;
use WPGraphQL\Types;

/**
 * Class TermObjectType
 *
 * This sets up the base TermObjectType. Custom taxonomies that are set to "show_in_graphql" will automatically
 * use the TermObjectType and inherit the fields that are defined here. The fields get passed through a
 * filter unique to each taxonomy, so each taxonomy can modify it's term schema via field filters.
 *
 * NOTE: In some cases, (probably rare, I would guess) the "shape" of a custom taxonomy term might not make sense to
 * inherit the fields defined here, so it might make sense for a Taxonomy to register it's own custom defined type
 * for it's terms instead of utilizing the TermObjectType.
 *
 * @package WPGraphQL\Type
 * @since   0.0.5
 */
class TermObjectType extends WPObjectType {

    /**
     * Holds the $fields definition for the TermObjectType
     *
     * @var $fields
     */
    private static $fields;

    /**
     * Holds the $taxonomy_object
     *
     * @var $taxonomy_object
     */
    private static $taxonomy_object;

    /**
     * TermObjectType constructor.
     *
     * @param string $taxonomy The taxonomy name
     *
     * @since 0.0.5
     */
    public function __construct( $taxonomy ) {

        /**
         * Get the taxonomy object and store it
         *
         * @since 0.0.5
         */
        self::$taxonomy_object = get_taxonomy( $taxonomy );

        $config = [
            'name'        => ucfirst( self::$taxonomy_object->graphql_single_name ),
            'description' => sprintf( __( 'The % object type', 'wp-graphql' ), self::$taxonomy_object->graphql_single_name ),
            'fields'      => self::fields( self::$taxonomy_object ),
            'interfaces'  => [ self::node_interface() ],
        ];
        parent::__construct( $config );
    }

    /**
     * fields
     *
     * This defines the fields for TermObjectType
     *
     * @param \WP_Taxonomy $taxonomy_object
     * @return \GraphQL\Type\Definition\FieldDefinition|mixed|null
     * @since 0.0.5
     */
    private static function fields( $taxonomy_object ) {

        /**
         * Get the $single_name out of the taxonomy_object
         *
         * @since 0.0.5
         */
        $single_name = self::$taxonomy_object->graphql_single_name;

        /**
         * If no fields have been defined for this type already,
         * make sure the $fields var is an empty array
         *
         * @since 0.0.5
         */
        if ( null === self::$fields ) {
            self::$fields = [];
        }

        /**
         * If the $fields haven't already been defined for this type,
         * define the fields
         *
         * @since 0.0.5
         */
        if ( empty( self::$fields[ $single_name ] ) ) :

            /**
             * Get the post_types and taxonomies that are allowed
             * in WPGraphQL
             *
             * @since 0.0.5
             */
            $allowed_post_types = \WPGraphQL::$allowed_post_types;

            /**
             * Define the fields for the terms of the specified taxonomy
             *
             * @return mixed
             * @since 0.0.5
             */
            self::$fields[ $single_name ] = function() use ( $single_name, $taxonomy_object, $allowed_post_types ) {
                $fields = [
                    'id'                => [
                        'type'    => Types::non_null( Types::id() ),
                        # Placeholder is the name of the taxonomy
                        'description' => __( 'The global ID for the ' . $taxonomy_object->name, 'wp-graphql' ),
                        'resolve' => function( \WP_Term $term, $args, AppContext $context, ResolveInfo $info ) {
                            return ( ! empty( $term->taxonomy ) && ! empty( $term->term_id ) ) ? Relay::toGlobalId( $term->taxonomy, $term->term_id ) : null;
                        },
                    ],
                    $single_name . 'Id' => [
                        'type'        => Types::int(),
                        'description' => __( 'The id field matches the WP_Post->ID field.', 'wp-graphql' ),
                        'resolve'     => function( \WP_Term $term, $args, AppContext $context, ResolveInfo $info ) {
                            return ! empty( $term->term_id ) ? absint( $term->term_id ) : null;
                        },
                    ],
                    'count' => [
                        'type' => Types::int(),
                        'description' => __( 'The number of objects connected to the object', 'wp-graphql' ),
                        'resolve'     => function( \WP_Term $term, array $args, AppContext $context, ResolveInfo $info ) {
                            return ! empty( $term->count ) ? absint( $term->count ) : null;
                        },
                    ],
                    'description'       => [
                        'type'        => Types::string(),
                        'description' => __( 'The description of the object', 'wp-graphql' ),
                        'resolve'     => function( \WP_Term $term, array $args, AppContext $context, ResolveInfo $info ) {
                            return ! empty( $term->description ) ? $term->description : null;
                        },
                    ],
                    'name'              => [
                        'type'        => Types::string(),
                        'description' => __( 'The human friendly name of the object.', 'wp-graphql' ),
                        'resolve'     => function( \WP_Term $term, array $args, AppContext $context, ResolveInfo $info ) {
                            return ! empty( $term->name ) ? $term->name : null;
                        },
                    ],
                    'slug'              => [
                        'type'        => Types::string(),
                        'description' => __( 'An alphanumeric identifier for the object unique to its type.', 'wp-graphql' ),
                        'resolve'     => function( \WP_Term $term, array $args, AppContext $context, ResolveInfo $info ) {
                            return ! empty( $term->slug ) ? $term->slug : null;
                        },
                    ],
                    'termGroupId'       => [
                        'type'        => Types::int(),
                        'description' => __( 'The ID of the term group that this term object belongs to', 'wp-graphql' ),
                        'resolve'     => function( \WP_Term $term, array $args, AppContext $context, ResolveInfo $info ) {
                            return ! empty( $term->term_group ) ? absint( $term->term_group ) : null;
                        },
                    ],
                    'termTaxonomyId'    => [
                        'type'        => Types::int(),
                        'description' => __( 'The taxonomy ID that the object is associated with', 'wp-graphql' ),
                        'resolve'     => function( \WP_Term $term, array $args, AppContext $context, ResolveInfo $info ) {
                            return ! empty( $term->term_taxonomy_id ) ? absint( $term->term_taxonomy_id ) : null;
                        },
                    ],
                    'taxonomy'          => [
                        'type'        => Types::taxonomy(),
                        'description' => __( 'The name of the taxonomy this term belongs to', 'wp-graphql' ),
                        'resolve'     => function( \WP_Term $term, array $args, AppContext $context, ResolveInfo $info ) {
                            $taxonomy = get_taxonomy( $term->taxonomy );

                            return ! empty( $term->taxonomy ) && false !== $taxonomy ? $taxonomy : null;
                        },
                    ],
                    'link'              => [
                        'type'        => Types::string(),
                        'description' => __( 'The link to the term', 'wp-graphql' ),
                        'resolve'     => function( \WP_Term $term, $args, AppContext $context, ResolveInfo $info ) {
                            $link = get_term_link( $term->term_id );

                            return ( ! is_wp_error( $link ) ) ? $link : null;
                        },
                    ],
                ];

                /**
                 * For hierarchical taxonomies, provide parent and ancestor fields
                 */
                if ( true === $taxonomy_object->hierarchical ) {
                    $fields['parent'] = [
                        'type' => Types::term_object( $taxonomy_object->name ),
                        'description' => __( 'The parent object', 'wp-graphql' ),
                        'resolve' => function( \WP_Term $term, $args, AppContext $context, ResolveInfo $info ) {
                            return ! empty( $term->parent ) ? DataSource::resolve_term_object( $term->parent, $term->taxonomy ) : null;
                        },
                    ];

                    $fields['ancestors'] = [
                        'type' => Types::list_of( Types::term_object( $taxonomy_object->name ) ),
                        'description' => esc_html__( 'The ancestors of the object', 'wp-graphql' ),
                        'resolve' => function( \WP_Term $term, $args, AppContext $context, ResolveInfo $info ) {
                            $ancestors = [];
                            $ancestor_ids = get_ancestors( $term->term_id, $term->taxonomy );
                            if ( ! empty( $ancestor_ids ) ) {
                                foreach ( $ancestor_ids as $ancestor_id ) {
                                    $ancestors[] = get_term( $ancestor_id );
                                }
                            }
                            return ! empty( $ancestors ) ? $ancestors : null;
                        },
                    ];

                    $fields['children'] = TermObjectConnectionDefinition::connection( $taxonomy_object );

                }

                /**
                 * Add connections for post_types that are registered to the taxonomy
                 *
                 * @since 0.0.5
                 */
                if ( ! empty( $allowed_post_types ) && is_array( $allowed_post_types ) ) {
                    foreach ( $allowed_post_types as $post_type ) {
                        if ( in_array( $post_type, $taxonomy_object->object_type, true ) ) {
                            $post_type_object                                 = get_post_type_object( $post_type );
                            $fields[ $post_type_object->graphql_plural_name ] = PostObjectConnectionDefinition::connection( $post_type_object );
                        }
                    }
                }

                /**
                 * 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.
                 *
                 * @since 0.0.5
                 */
                return self::prepare_fields( $fields, $single_name );

            };
        endif;
        return ! empty( self::$fields[ $single_name ] ) ? self::$fields[ $single_name ] : null;
    }
}

Namespaces

Classes

Interfaces