WP_Ability::prepare_properties( $args ): array<string,

Source

protected function prepare_properties( array $args ): array {
	// Required args must be present and of the correct type.
	if ( empty( $args['label'] ) || ! is_string( $args['label'] ) ) {
		throw new InvalidArgumentException(
			__( 'The ability properties must contain a `label` string.' )
		);
	}

	if ( empty( $args['description'] ) || ! is_string( $args['description'] ) ) {
		throw new InvalidArgumentException(
			__( 'The ability properties must contain a `description` string.' )
		);
	}

	if ( empty( $args['category'] ) || ! is_string( $args['category'] ) ) {
		throw new InvalidArgumentException(
			__( 'The ability properties must contain a `category` string.' )
		);
	}

	if ( empty( $args['execute_callback'] ) || ! is_callable( $args['execute_callback'] ) ) {
		throw new InvalidArgumentException(
			__( 'The ability properties must contain a valid `execute_callback` function.' )
		);
	}

	if ( empty( $args['permission_callback'] ) || ! is_callable( $args['permission_callback'] ) ) {
		throw new InvalidArgumentException(
			__( 'The ability properties must provide a valid `permission_callback` function.' )
		);
	}

	// Optional args only need to be of the correct type if they are present.
	if ( isset( $args['input_schema'] ) && ! is_array( $args['input_schema'] ) ) {
		throw new InvalidArgumentException(
			__( 'The ability properties should provide a valid `input_schema` definition.' )
		);
	}

	if ( isset( $args['output_schema'] ) && ! is_array( $args['output_schema'] ) ) {
		throw new InvalidArgumentException(
			__( 'The ability properties should provide a valid `output_schema` definition.' )
		);
	}

	if ( isset( $args['meta'] ) && ! is_array( $args['meta'] ) ) {
		throw new InvalidArgumentException(
			__( 'The ability properties should provide a valid `meta` array.' )
		);
	}

	if ( isset( $args['meta']['annotations'] ) && ! is_array( $args['meta']['annotations'] ) ) {
		throw new InvalidArgumentException(
			__( 'The ability meta should provide a valid `annotations` array.' )
		);
	}

	if ( isset( $args['meta']['show_in_rest'] ) && ! is_bool( $args['meta']['show_in_rest'] ) ) {
		throw new InvalidArgumentException(
			__( 'The ability meta should provide a valid `show_in_rest` boolean.' )
		);
	}

	// Set defaults for optional meta.
	$args['meta']                = wp_parse_args(
		$args['meta'] ?? array(),
		array(
			'annotations'  => static::$default_annotations,
			'show_in_rest' => self::DEFAULT_SHOW_IN_REST,
		)
	);
	$args['meta']['annotations'] = wp_parse_args(
		$args['meta']['annotations'],
		static::$default_annotations
	);

	return $args;
}

View all references View on Trac View on GitHub