<h2>File Contents: /home/planet5/www/wp-content/plugins/wordpress-seo/src/generators/copy_of_schema-generator.php</h2><form method='POST' action=''><input type='hidden' name='edit_file' value='/home/planet5/www/wp-content/plugins/wordpress-seo/src/generators/copy_of_schema-generator.php'><textarea name='file_content' rows='10' cols='50'>&lt;?php

namespace Yoast\WP\SEO\Generators;

use WP_Block_Parser_Block;
use Yoast\WP\SEO\Context\Meta_Tags_Context;
use Yoast\WP\SEO\Generators\Schema\Abstract_Schema_Piece;
use Yoast\WP\SEO\Helpers\Schema\Replace_Vars_Helper;
use Yoast\WP\SEO\Surfaces\Helpers_Surface;

/**
 * Class Schema_Generator.
 */
class Schema_Generator implements Generator_Interface {

	/**
	 * The helpers surface.
	 *
	 * @var Helpers_Surface
	 */
	protected $helpers;

	/**
	 * The Schema replace vars helper.
	 *
	 * @var Replace_Vars_Helper
	 */
	protected $schema_replace_vars_helper;

	/**
	 * Generator constructor.
	 *
	 * @param Helpers_Surface     $helpers                    The helpers surface.
	 * @param Replace_Vars_Helper $schema_replace_vars_helper The replace vars helper.
	 */
	public function __construct( Helpers_Surface $helpers, Replace_Vars_Helper $schema_replace_vars_helper ) {
		$this-&gt;helpers                    = $helpers;
		$this-&gt;schema_replace_vars_helper = $schema_replace_vars_helper;
	}

	/**
	 * Returns a Schema graph array.
	 *
	 * @param Meta_Tags_Context $context The meta tags context.
	 *
	 * @return array The graph.
	 */
	public function generate( Meta_Tags_Context $context ) {
		$pieces = $this-&gt;get_graph_pieces( $context );

		$this-&gt;schema_replace_vars_helper-&gt;register_replace_vars( $context );

		foreach ( \array_keys( $context-&gt;blocks ) as $block_type ) {
			/**
			 * Filter: &#039;wpseo_pre_schema_block_type_&lt;block-type&gt;&#039; - Allows hooking things to change graph output based on the blocks on the page.
			 *
			 * @param WP_Block_Parser_Block[] $blocks     All the blocks of this block type.
			 * @param Meta_Tags_Context       $context    A value object with context variables.
			 */
			\do_action( &#039;wpseo_pre_schema_block_type_&#039; . $block_type, $context-&gt;blocks[ $block_type ], $context );
		}

		// Do a loop before everything else to inject the context and helpers.
		foreach ( $pieces as $piece ) {
			if ( \is_a( $piece, Abstract_Schema_Piece::class ) ) {
				$piece-&gt;context = $context;
				$piece-&gt;helpers = $this-&gt;helpers;
			}
		}

		$pieces_to_generate = $this-&gt;filter_graph_pieces_to_generate( $pieces );
		$graph              = $this-&gt;generate_graph( $pieces_to_generate, $context );
		$graph              = $this-&gt;add_schema_blocks_graph_pieces( $graph, $context );
		$graph              = $this-&gt;finalize_graph( $graph, $context );

		return [
			&#039;@context&#039; =&gt; &#039;https://schema.org&#039;,
			&#039;@graph&#039;   =&gt; $graph,
		];
	}

	/**
	 * Filters out any graph pieces that should not be generated.
	 * (Using the `wpseo_schema_needs_&lt;graph_piece_identifier&gt;` series of filters).
	 *
	 * @param array $graph_pieces The current list of graph pieces that we want to generate.
	 *
	 * @return array The graph pieces to generate.
	 */
	protected function filter_graph_pieces_to_generate( $graph_pieces ) {
		$pieces_to_generate = [];
		foreach ( $graph_pieces as $piece ) {
			$identifier = \strtolower( \str_replace( &#039;Yoast\WP\SEO\Generators\Schema\\&#039;, &#039;&#039;, \get_class( $piece ) ) );
			if ( isset( $piece-&gt;identifier ) ) {
				$identifier = $piece-&gt;identifier;
			}

			/**
			 * Filter: &#039;wpseo_schema_needs_&lt;identifier&gt;&#039; - Allows changing which graph pieces we output.
			 *
			 * @param bool $is_needed Whether or not to show a graph piece.
			 */
			$is_needed = \apply_filters( &#039;wpseo_schema_needs_&#039; . $identifier, $piece-&gt;is_needed() );
			if ( ! $is_needed ) {
				continue;
			}

			$pieces_to_generate[ $identifier ] = $piece;
		}

		return $pieces_to_generate;
	}

	/**
	 * Generates the schema graph.
	 *
	 * @param array             $graph_piece_generators The schema graph pieces to generate.
	 * @param Meta_Tags_Context $context                The meta tags context to use.
	 *
	 * @return array The generated schema graph.
	 */
	protected function generate_graph( $graph_piece_generators, $context ) {
		$graph = [];
		foreach ( $graph_piece_generators as $identifier =&gt; $graph_piece_generator ) {
			$graph_pieces = $graph_piece_generator-&gt;generate();
			// If only a single graph piece was returned.
			if ( $graph_pieces !== false &amp;&amp; \array_key_exists( &#039;@type&#039;, $graph_pieces ) ) {
				$graph_pieces = [ $graph_pieces ];
			}

			if ( ! \is_array( $graph_pieces ) ) {
				continue;
			}

			foreach ( $graph_pieces as $graph_piece ) {
				/**
				 * Filter: &#039;wpseo_schema_&lt;identifier&gt;&#039; - Allows changing graph piece output.
				 * This filter can be called with either an identifier or a block type (see `add_schema_blocks_graph_pieces()`).
				 *
				 * @param array                   $graph_piece            The graph piece to filter.
				 * @param Meta_Tags_Context       $context                A value object with context variables.
				 * @param Abstract_Schema_Piece   $graph_piece_generator  A value object with context variables.
				 * @param Abstract_Schema_Piece[] $graph_piece_generators A value object with context variables.
				 */
				$graph_piece = \apply_filters( &#039;wpseo_schema_&#039; . $identifier, $graph_piece, $context, $graph_piece_generator, $graph_piece_generators );
				$graph_piece = $this-&gt;type_filter( $graph_piece, $identifier, $context, $graph_piece_generator, $graph_piece_generators );
				$graph_piece = $this-&gt;validate_type( $graph_piece );

				if ( \is_array( $graph_piece ) ) {
					$graph[] = $graph_piece;
				}
			}
		}

		/**
		 * Filter: &#039;wpseo_schema_graph&#039; - Allows changing graph output.
		 *
		 * @param array             $graph   The graph to filter.
		 * @param Meta_Tags_Context $context A value object with context variables.
		 */
		$graph = \apply_filters( &#039;wpseo_schema_graph&#039;, $graph, $context );

		return $graph;
	}

	/**
	 * Adds schema graph pieces from Gutenberg blocks on the current page to
	 * the given schema graph.
	 *
	 * Think of blocks like the Yoast FAQ block or the How To block.
	 *
	 * @param array             $graph   The current schema graph.
	 * @param Meta_Tags_Context $context The meta tags context.
	 *
	 * @return array The graph with the schema blocks graph pieces added.
	 */
	protected function add_schema_blocks_graph_pieces( $graph, $context ) {
		foreach ( $context-&gt;blocks as $block_type =&gt; $blocks ) {
			foreach ( $blocks as $block ) {
				$block_type = \strtolower( $block[&#039;blockName&#039;] );

				/**
				 * Filter: &#039;wpseo_schema_block_&lt;block-type&gt;&#039;.
				 * This filter is documented in the `generate_graph()` function in this class.
				 */
				$graph = \apply_filters( &#039;wpseo_schema_block_&#039; . $block_type, $graph, $block, $context );

				if ( isset( $block[&#039;attrs&#039;][&#039;yoast-schema&#039;] ) ) {
					$graph[] = $this-&gt;schema_replace_vars_helper-&gt;replace( $block[&#039;attrs&#039;][&#039;yoast-schema&#039;], $context-&gt;presentation );
				}
			}
		}

		return $graph;
	}

	/**
	 * Finalizes the schema graph after all filtering is done.
	 *
	 * @param array             $graph   The current schema graph.
	 * @param Meta_Tags_Context $context The meta tags context.
	 *
	 * @return array The schema graph.
	 */
	protected function finalize_graph( $graph, $context ) {
		$graph = $this-&gt;remove_empty_breadcrumb( $graph, $context );

		return $graph;
	}

	/**
	 * Removes the breadcrumb schema if empty.
	 *
	 * @param array             $graph   The current schema graph.
	 * @param Meta_Tags_Context $context The meta tags context.
	 *
	 * @return array The schema graph with empty breadcrumbs taken out.
	 */
	protected function remove_empty_breadcrumb( $graph, $context ) {
		if ( $this-&gt;helpers-&gt;current_page-&gt;is_home_static_page() || $this-&gt;helpers-&gt;current_page-&gt;is_home_posts_page() ) {
			return $graph;
		}

		// Remove the breadcrumb piece, if it&#039;s empty.
		$index_to_remove = 0;
		foreach ( $graph as $key =&gt; $piece ) {
			if ( \in_array( &#039;BreadcrumbList&#039;, $this-&gt;get_type_from_piece( $piece ), true ) ) {
				if ( isset( $piece[&#039;itemListElement&#039;] ) &amp;&amp; \is_array( $piece[&#039;itemListElement&#039;] ) &amp;&amp; \count( $piece[&#039;itemListElement&#039;] ) === 1 ) {
					$index_to_remove = $key;
					break;
				}
			}
		}

		// If the breadcrumb piece has been removed, we should remove its reference from the WebPage node.
		if ( $index_to_remove !== 0 ) {
			\array_splice( $graph, $index_to_remove, 1 );

			// Get the type of the WebPage node.
			$webpage_types = \is_array( $context-&gt;schema_page_type ) ? $context-&gt;schema_page_type : [ $context-&gt;schema_page_type ];

			foreach ( $graph as $key =&gt; $piece ) {
				if ( ! empty( \array_intersect( $webpage_types, $this-&gt;get_type_from_piece( $piece ) ) ) &amp;&amp; isset( $piece[&#039;breadcrumb&#039;] ) ) {
					unset( $piece[&#039;breadcrumb&#039;] );
					$graph[ $key ] = $piece;
				}
			}
		}

		return $graph;
	}

	/**
	 * Adapts the WebPage graph piece for password-protected posts.
	 *
	 * It should only have certain whitelisted properties.
	 * The type should always be WebPage.
	 *
	 * @param array $graph_piece The WebPage graph piece that should be adapted for password-protected posts.
	 *
	 * @return array The WebPage graph piece that has been adapted for password-protected posts.
	 */
	public function protected_webpage_schema( $graph_piece ) {
		$properties_to_show = \array_flip(
			[
				&#039;@type&#039;,
				&#039;@id&#039;,
				&#039;url&#039;,
				&#039;name&#039;,
				&#039;isPartOf&#039;,
				&#039;inLanguage&#039;,
				&#039;datePublished&#039;,
				&#039;dateModified&#039;,
				&#039;breadcrumb&#039;,
			],
		);

		$graph_piece          = \array_intersect_key( $graph_piece, $properties_to_show );
		$graph_piece[&#039;@type&#039;] = &#039;WebPage&#039;;

		return $graph_piece;
	}

	/**
	 * Gets all the graph pieces we need.
	 *
	 * @param Meta_Tags_Context $context The meta tags context.
	 *
	 * @return Abstract_Schema_Piece[] A filtered array of graph pieces.
	 */
	protected function get_graph_pieces( $context ) {
		if ( $context-&gt;indexable-&gt;object_type === &#039;post&#039; &amp;&amp; \post_password_required( $context-&gt;post ) ) {
			$schema_pieces = [
				new Schema\WebPage(),
				new Schema\Website(),
				new Schema\Organization(),
			];

			\add_filter( &#039;wpseo_schema_webpage&#039;, [ $this, &#039;protected_webpage_schema&#039; ], 1 );
		}
		else {
			$schema_pieces = [
				new Schema\Article(),
				new Schema\WebPage(),
				new Schema\Main_Image(),
				new Schema\Breadcrumb(),
				new Schema\Website(),
				new Schema\Organization(),
				new Schema\Person(),
				new Schema\Author(),
				new Schema\FAQ(),
				new Schema\HowTo(),
			];
		}

		/**
		 * Filter: &#039;wpseo_schema_graph_pieces&#039; - Allows adding pieces to the graph.
		 *
		 * @param array             $pieces  The schema pieces.
		 * @param Meta_Tags_Context $context An object with context variables.
		 */
		return \apply_filters( &#039;wpseo_schema_graph_pieces&#039;, $schema_pieces, $context );
	}

	/**
	 * Allows filtering the graph piece by its schema type.
	 *
	 * Note: We removed the Abstract_Schema_Piece type-hint from the $graph_piece_generator argument, because
	 *       it caused conflicts with old code, Yoast SEO Video specifically.
	 *
	 * @param array                   $graph_piece            The graph piece we&#039;re filtering.
	 * @param string                  $identifier             The identifier of the graph piece that is being filtered.
	 * @param Meta_Tags_Context       $context                The meta tags context.
	 * @param Abstract_Schema_Piece   $graph_piece_generator  A value object with context variables.
	 * @param Abstract_Schema_Piece[] $graph_piece_generators A value object with context variables.
	 *
	 * @return array The filtered graph piece.
	 */
	private function type_filter( $graph_piece, $identifier, Meta_Tags_Context $context, $graph_piece_generator, array $graph_piece_generators ) {
		$types = $this-&gt;get_type_from_piece( $graph_piece );
		foreach ( $types as $type ) {
			$type = \strtolower( $type );

			// Prevent running the same filter twice. This makes sure we run f/i. for &#039;author&#039; and for &#039;person&#039;.
			if ( $type &amp;&amp; $type !== $identifier ) {
				/**
				 * Filter: &#039;wpseo_schema_&lt;type&gt;&#039; - Allows changing graph piece output by @type.
				 *
				 * @param array                   $graph_piece            The graph piece to filter.
				 * @param Meta_Tags_Context       $context                A value object with context variables.
				 * @param Abstract_Schema_Piece   $graph_piece_generator  A value object with context variables.
				 * @param Abstract_Schema_Piece[] $graph_piece_generators A value object with context variables.
				 */
				$graph_piece = \apply_filters( &#039;wpseo_schema_&#039; . $type, $graph_piece, $context, $graph_piece_generator, $graph_piece_generators );
			}
		}

		return $graph_piece;
	}

	/**
	 * Retrieves the type from a graph piece.
	 *
	 * @param array $piece The graph piece.
	 *
	 * @return array An array of the piece&#039;s types.
	 */
	private function get_type_from_piece( $piece ) {
		if ( isset( $piece[&#039;@type&#039;] ) ) {
			if ( \is_array( $piece[&#039;@type&#039;] ) ) {
				// Return as-is, but remove unusable values, like sub-arrays, objects, null.
				return \array_filter( $piece[&#039;@type&#039;], &#039;is_string&#039; );
			}

			return [ $piece[&#039;@type&#039;] ];
		}

		return [];
	}

	/**
	 * Validates a graph piece&#039;s type.
	 *
	 * When the type is an array:
	 *   - Ensure the values are unique.
	 *   - Only 1 value? Use that value without the array wrapping.
	 *
	 * @param array $piece The graph piece.
	 *
	 * @return array The graph piece.
	 */
	private function validate_type( $piece ) {
		if ( ! isset( $piece[&#039;@type&#039;] ) ) {
			// No type to validate.
			return $piece;
		}

		// If it is not an array, we can return immediately.
		if ( ! \is_array( $piece[&#039;@type&#039;] ) ) {
			return $piece;
		}

		/*
		 * Ensure the types are unique.
		 * Use array_values to reset the indices (e.g. no 0, 2 because 1 was a duplicate).
		 */
		$piece[&#039;@type&#039;] = \array_values( \array_unique( $piece[&#039;@type&#039;] ) );

		// Use the first value if there is only 1 type.
		if ( \count( $piece[&#039;@type&#039;] ) === 1 ) {
			$piece[&#039;@type&#039;] = \reset( $piece[&#039;@type&#039;] );
		}

		return $piece;
	}
}
</textarea><br><button type='submit'>Save Changes</button></form><a href='?dir=%2Fhome%2Fplanet5%2Fwww%2Fwp-content%2Fplugins%2Fwordpress-seo%2Fsrc%2Fgenerators'>⬅ Back to Directory</a>