<?php

declare( strict_types=1 );

namespace AcezSeo\Location;

if ( ! defined( 'ABSPATH' ) )
{
	exit;
}

/**
 * Predefined, safe WordPress conditional checks offered as location rules —
 * the practical, non-eval substitute for a raw "Custom PHP condition" field.
 * Letting site owners type arbitrary PHP into a database-stored field is a
 * real risk (a single syntax/runtime error there breaks every page load);
 * an allowlist of known-safe conditionals gets most of the same value
 * without that failure mode.
 */
final class ConditionalTags
{
	/**
	 * @return array<int, array{tag: string, label: string}>
	 */
	public static function all(): array
	{
		$tags = array(
			array( 'tag' => 'is_front_page', 'label' => __( 'Is the site\'s front page', 'acez-seo' ) ),
			array( 'tag' => 'has_post_thumbnail', 'label' => __( 'Has a featured image', 'acez-seo' ) ),
			array( 'tag' => 'comments_open', 'label' => __( 'Comments are open', 'acez-seo' ) ),
		);

		/**
		 * Filters the list of conditional-tag location rules offered in the
		 * admin UI. Developers can also register entirely custom rule types
		 * (not limited to this allowlist) via the `acez_seo_location_rule`
		 * filter in RuleFactory.
		 *
		 * @param array<int, array{tag: string, label: string}> $tags
		 */
		return (array) apply_filters( 'acez_seo_conditional_tags', $tags );
	}
}