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 
<?php

namespace WPGraphQL\Type\Comment;

use GraphQL\Type\Definition\ResolveInfo;
use GraphQLRelay\Relay;
use WPGraphQL\AppContext;
use WPGraphQL\Data\DataSource;
use WPGraphQL\Type\Comment\Connection\CommentConnectionDefinition;
use WPGraphQL\Type\WPObjectType;
use WPGraphQL\Types;

class CommentType extends WPObjectType {

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

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

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

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

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

        parent::__construct( $config );

    }

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

        if ( null === self::$fields ) :
            self::$fields = function() {
                $fields = [
                    'id'          => [
                        'type'        => Types::non_null( Types::id() ),
                        'description' => __( 'The globally unique identifier for the user', 'wp-graphql' ),
                        'resolve'     => function( \WP_Comment $comment, $args, AppContext $context, ResolveInfo $info ) {
                            return ! empty( $comment->comment_ID ) ? Relay::toGlobalId( 'comment', $comment->comment_ID ) : null;
                        },
                    ],
                    'commentId'   => [
                        'type'        => Types::int(),
                        'description' => __( 'ID for the comment, unique among comments.', 'wp-graphql' ),
                        'resolve'     => function( \WP_Comment $comment, $args, AppContext $context, ResolveInfo $info ) {
                            return ! empty( $comment->comment_ID ) ? $comment->comment_ID : 0;
                        },
                    ],
                    'commentedOn' => [
                        'type'        => Types::post_object_union(),
                        'description' => __( 'The object the comment was added to', 'wp-graphql' ),
                        'resolve'     => function( \WP_Comment $comment, $args, AppContext $context, ResolveInfo $info ) {
                            return ! empty( $comment->comment_post_ID ) ? get_post( $comment->comment_post_ID ) : null;
                        },
                    ],
                    'author'      => [
                        'type'        => Types::comment_author_union(),
                        'description' => __( 'The author of the comment', 'wp-graphql' ),
                        'resolve'     => function( \WP_Comment $comment, $args, AppContext $context, ResolveInfo $info ) {
                            /**
                             * If the comment has a user associated, use it to populate the author, otherwise return
                             * the $comment and the Union will use that to hydrate the CommentAuthor Type
                             */
                            if ( ! empty( $comment->user_id ) ) {
                                return DataSource::resolve_user( absint( $comment->user_id ) );
                            } else {
                                return DataSource::resolve_comment_author( $comment->comment_author_email );
                            }
                        },
                    ],
                    'authorIp'    => [
                        'type'        => Types::string(),
                        'description' => __( 'IP address for the author. This field is equivalent to WP_Comment->comment_author_IP and the value matching the `comment_author_IP` column in SQL.', 'wp-graphql' ),
                        'resolve'     => function( \WP_Comment $comment, $args, AppContext $context, ResolveInfo $info ) {
                            return ! empty( $comment->comment_author_IP ) ? $comment->comment_author_IP : '';
                        },
                    ],
                    'date'        => [
                        'type'        => Types::string(),
                        'description' => __( 'Date the comment was posted in local time. This field is equivalent to WP_Comment->date and the value matching the `date` column in SQL.', 'wp-graphql' ),
                        'resolve'     => function( \WP_Comment $comment, $args, AppContext $context, ResolveInfo $info ) {
                            return ! empty( $comment->comment_date ) ? $comment->comment_date : '';
                        },
                    ],
                    'dateGmt'     => [
                        'type'        => Types::string(),
                        'description' => __( 'Date the comment was posted in GMT. This field is equivalent to WP_Comment->date_gmt and the value matching the `date_gmt` column in SQL.', 'wp-graphql' ),
                        'resolve'     => function( \WP_Comment $comment, $args, AppContext $context, ResolveInfo $info ) {
                            return ! empty( $comment->comment_date_gmt ) ? $comment->comment_date_gmt : '';
                        },
                    ],
                    'content'     => [
                        'type'        => Types::string(),
                        'description' => __( 'Content of the comment. This field is equivalent to WP_Comment->comment_content and the value matching the `comment_content` column in SQL.', 'wp-graphql' ),
                        'resolve'     => function( \WP_Comment $comment, $args, AppContext $context, ResolveInfo $info ) {
                            return ! empty( $comment->comment_content ) ? $comment->comment_content : '';
                        },
                    ],
                    'karma'       => [
                        'type'        => Types::int(),
                        'description' => __( 'Karma value for the comment. This field is equivalent to WP_Comment->comment_karma and the value matching the `comment_karma` column in SQL.', 'wp-graphql' ),
                        'resolve'     => function( \WP_Comment $comment, $args, AppContext $context, ResolveInfo $info ) {
                            return ! empty( $comment->comment_karma ) ? $comment->comment_karma : 0;
                        },
                    ],
                    'approved'    => [
                        'type'        => Types::string(),
                        'description' => __( 'The approval status of the comment. This field is equivalent to WP_Comment->comment_approved and the value matching the `comment_approved` column in SQL.', 'wp-graphql' ),
                        'resolve'     => function( \WP_Comment $comment, $args, AppContext $context, ResolveInfo $info ) {
                            return ! empty( $comment->comment_approved ) ? $comment->comment_approved : '';
                        },
                    ],
                    'agent'       => [
                        'type'        => Types::string(),
                        'description' => __( 'User agent used to post the comment. This field is equivalent to WP_Comment->comment_agent and the value matching the `comment_agent` column in SQL.', 'wp-graphql' ),
                        'resolve'     => function( \WP_Comment $comment, $args, AppContext $context, ResolveInfo $info ) {
                            return ! empty( $comment->comment_agent ) ? $comment->comment_agent : '';
                        },
                    ],
                    'type'        => [
                        'type'        => Types::string(),
                        'description' => __( 'Type of comment. This field is equivalent to WP_Comment->comment_type and the value matching the `comment_type` column in SQL.', 'wp-graphql' ),
                        'resolve'     => function( \WP_Comment $comment, $args, AppContext $context, ResolveInfo $info ) {
                            return ! empty( $comment->comment_type ) ? $comment->comment_type : '';
                        },
                    ],
                    'parent'      => [
                        'type'        => Types::comment(),
                        'description' => __( 'Parent comment of current comment. This field is equivalent to the WP_Comment instance matching the WP_Comment->comment_parent ID.', 'wp-graphql' ),
                        'resolve'     => function( \WP_Comment $comment, $args, AppContext $context, ResolveInfo $info ) {
                            return get_comment( $comment->comment_parent );
                        },
                    ],
                ];

                /**
                 * Add a comments_connection to display the child comments
                 *
                 * @since 0.0.5
                 */
                $fields['children'] = CommentConnectionDefinition::connection();

                /**
                 * 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