File Type/MediaItem/Mutation/MediaItemDelete.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

<?php

namespace WPGraphQL\Type\MediaItem\Mutation;

use GraphQL\Error\UserError;
use GraphQLRelay\Relay;
use WPGraphQL\Types;

/**
 * Class MediaItemDelete
 *
 * @package WPGraphQL\Type\mediaItem\Mutation
 */
class MediaItemDelete {

    /**
     * Holds the mutation field definition
     *
     * @var array $mutation
     */
    private static $mutation = [];

    /**
     * Defines the delete mutation for MediaItems
     *
     * @param \WP_Post_Type $post_type_object
     *
     * @return array|mixed
     */
    public static function mutate( \WP_Post_Type $post_type_object ) {

        /**
         * Set the name of the media item mutation being performed
         */
        $mutation_name = 'DeleteMediaItem';

        self::$mutation['mediaItem'] = Relay::mutationWithClientMutationId( [
            'name'                => esc_html( $mutation_name ),
            'description'         => __( 'Delete mediaItem objects. By default mediaItem objects will be moved to the trash unless the forceDelete is used', 'wp-graphql' ),
            'inputFields'         => [
                'id'          => [
                    'type'        => Types::non_null( Types::id() ),
                    'description' => __( 'The ID of the mediaItem to delete', 'wp-graphql' ),
                ],
                'forceDelete' => [
                    'type'        => Types::boolean(),
                    'description' => __( 'Whether the mediaItem should be force deleted instead of being moved to the trash', 'wp-graphql' ),
                ],
            ],
            'outputFields'        => [
                'deletedId' => [
                    'type'        => Types::id(),
                    'description' => __( 'The ID of the deleted mediaItem', 'wp-graphql' ),
                    'resolve'     => function( $payload ) use ( $post_type_object ) {
                        $deleted = (object) $payload['mediaItemObject'];
                        return ! empty( $deleted->ID ) ? Relay::toGlobalId( $post_type_object->name, absint( $deleted->ID ) ) : null;
                    },
                ],
                'mediaItem' => [
                    'type'        => Types::post_object( $post_type_object->name ),
                    'description' => __( 'The mediaItem before it was deleted', 'wp-graphql' ),
                    'resolve'     => function( $payload ) {
                        $deleted = (object) $payload['mediaItemObject'];
                        return ! empty( $deleted ) ? $deleted : null;
                    },
                ],
            ],
            'mutateAndGetPayload' => function( $input ) use ( $post_type_object, $mutation_name ) {

                /**
                 * Get the ID from the global ID
                 */
                $id_parts = Relay::fromGlobalId( $input['id'] );
                $existing_media_item = get_post( absint( $id_parts['id'] ) );

                /**
                 * If there's no existing mediaItem, throw an exception
                 */
                if ( empty( $existing_media_item ) ) {
                    throw new UserError( __( 'No mediaItem could be found to delete', 'wp-graphql' ) );
                }

                /**
                 * Stop now if a user isn't allowed to delete a mediaItem
                 */
                if ( ! current_user_can( $post_type_object->cap->delete_post, absint( $id_parts['id'] ) ) ) {
                    throw new UserError( __( 'Sorry, you are not allowed to delete mediaItems', 'wp-graphql' ) );
                }

                /**
                 * Check if we should force delete or not
                 */
                $force_delete = ( ! empty( $input['forceDelete'] ) && true === $input['forceDelete'] ) ? true : false;

                /**
                 * Get the mediaItem object before deleting it
                 */
                $media_item_before_delete = get_post( absint( $id_parts['id'] ) );

                /**
                 * If the mediaItem isn't of the attachment post type, throw an error
                 */
                if ( 'attachment' !== $media_item_before_delete->post_type ) {
                    throw new UserError( sprintf( __( 'Sorry, the item you are trying to delete is a %1%s, not a mediaItem', 'wp-graphql' ), $media_item_before_delete->post_type ) );
                }

                /**
                 * If the mediaItem is already in the trash, and the forceDelete input was not passed,
                 * don't remove from the trash
                 */
                if ( 'trash' === $media_item_before_delete->post_status ) {
                    if ( true !== $force_delete ) {
                        // Translators: the first placeholder is the post_type of the object being deleted and the second placeholder is the unique ID of that object
                        throw new UserError( sprintf( __( 'The mediaItem with id %1$s is already in the trash. To remove from the trash, use the forceDelete input', 'wp-graphql' ), $input['id'] ) );
                    }
                }

                /**
                 * Delete the mediaItem. This will not throw false thanks to
                 * all of the above validation
                 */
                $deleted = wp_delete_attachment( $id_parts['id'], $force_delete );

                /**
                 * If the post was moved to the trash, spoof the object's status before returning it
                 */
                $media_item_before_delete->post_status = ( false !== $deleted && true !== $force_delete ) ? 'trash' : $media_item_before_delete->post_status;

                /**
                 * Return the deletedId and the mediaItem before it was deleted
                 */
                return [
                    'mediaItemObject' => $media_item_before_delete,
                ];

            },
        ] );

        return ! empty( self::$mutation['mediaItem'] ) ? self::$mutation['mediaItem'] : null;

    }

}

Namespaces

Classes

Interfaces