Referencia de hooks públicos

Esta es la referencia compacta de los puntos de extensión de WordPress compatibles con POM Cache. Las guías enlazadas explican el momento de ejecución, la seguridad y ejemplos completos.

Las firmas que aparecen a continuación usan notación de referencia tipada para mostrar valores de retorno y argumentos; no son callbacks PHP listos para copiar y pegar.

Administración y clasificación de peticiones

`pom_cache_settings`

Filtra la definición de ajustes del POM Framework.

array apply_filters( 'pom_cache_settings', array $settings )

Úsalo solo para ampliar el modelo público de ajustes. Conserva las claves existentes y sigue los contratos de campos del POM Framework.

`pom_cache_disable_cache_on_wp_die`

Controla si al seleccionar el controlador POM Cache wp_die se define DONOTCACHEPAGE.

bool apply_filters( 'pom_cache_disable_cache_on_wp_die', true )

El valor predeterminado seguro es true.

`pom_cache_tracking_parameters`

Filtra la lista de parámetros de consulta que pueden descartarse como datos de seguimiento no representativos.

array apply_filters( 'pom_cache_tracking_parameters', array $parameters )

Añade una clave solo cuando su valor nunca cambie el contenido, los permisos, el idioma, el precio o el comportamiento de la página.

`pom_cache_query_variant`

Incorpora una ruta concreta a variantes de consulta HTML independientes y finitas. La política vacía predeterminada mantiene las consultas funcionales como dinámicas.

array apply_filters( 'pom_cache_query_variant', array $policy, array $query, string $path )

Devuelve namespace (cadena estable que identifica la representación/configuración), parameters (nombres de parámetros asignados a valores de cadena permitidos) y un max_age positivo en segundos. Los ignore opcionales nunca deben cambiar el contenido renderizado. Los nombres de seguimiento reconocidos se ignoran automáticamente. El headers opcional admite Cache-Control y X-Robots-Tag en lecturas cacheadas; el propietario también debe emitir esas cabeceras en los renderizados en vivo.

El propietario debe reconocer la ruta, aprobar la reutilización anónima y registrar el filtro antes de init. POM Cache rechaza parámetros no listados, valores no válidos, arrays y claves duplicadas. Las combinaciones ordenadas de parámetro/valor reciben entradas independientes, nunca la entrada sin consulta. Una política aprobada no omite las exclusiones de autenticación, sesión, método, error ni DONOTCACHEPAGE. Solo se almacena HTML HTTP 200 completo.

Las lecturas usan PHP en wp_loaded (phase=query), antes de que WordPress resuelva la consulta principal. Los archivos caducados se omiten; un renderizado correcto los reemplaza. Esto ahorra la resolución de la ruta y el renderizado, pero sigue iniciando WordPress. La entrega directa por Apache y el JSON progresivo no cambian. Limpiar una única URL HTML también limpia sus variantes de consulta. Consulta el ejemplo de integración.

`pom_cache_accept_headers`

Filtra los fragmentos de tipo de medio tratados como similares a JSON en lugar de HTML.

array apply_filters( 'pom_cache_accept_headers', array $media_types )

Los valores predeterminados incluyen application/json, application/activity+json y application/ld+json.

Lectura y generación de HTML

`pom_cache_can_serve_cached_file`

Filtra si un archivo HTML existente puede servirse.

bool apply_filters(
    'pom_cache_can_serve_cached_file',
    bool $can_serve,
    string $file,
    array $context
)

Las claves de contexto conocidas son phase, file, request_uri, request_method, has_cache_bypass_cookie, donotcachepage_defined y is_user_logged_in. Solo veta una lectura permitida; no conviertas una lectura rechazada en una permitida.

`pom_cache_ob_callback_filter`

Filtra el búfer renderizado en vivo antes de las comprobaciones finales de elegibilidad.

string apply_filters( 'pom_cache_ob_callback_filter', string $buffer )

Su resultado se devuelve al visitante y se convierte en el contenido candidato a caché.

`pom_cache_only_cache_known_pages`

Controla si una respuesta no clasificada se rechaza.

mixed apply_filters( 'pom_cache_only_cache_known_pages', 1 )

Mantén el valor predeterminado verdadero a menos que puedas demostrar que cada respuesta recién admitida es pública y está completa.

`pom_cache_404`

Controla la generación y entrega del único documento 404 público compartido. WordPress debe resolver primero la petición como un 404. Las URLs inexistentes nunca reciben archivos HTML por URL.

bool apply_filters( 'pom_cache_404', true )

`pom_cache_eof_tags`

Filtra la expresión regular utilizada para reconocer una respuesta completa.

string apply_filters( 'pom_cache_eof_tags', string $regular_expression )

Devuelve una expresión regular válida.

`pom_cache_buffer`

Filtra solo la copia a punto de almacenarse, después del comentario de tiempo de generación y antes de los comentarios finales de POM Cache.

string apply_filters( 'pom_cache_buffer', string $cached_copy )

El visitante actual recibe el búfer renderizado original.

Rutas de HTML y eliminación

`pom_cache_cache_dir`

Filtra la ruta base absoluta de la caché HTML del sitio actual.

string apply_filters( 'pom_cache_cache_dir', string $absolute_path )

`pom_cache_dir`

Filtra el fragmento relativo de host y petición utilizado para construir un directorio de caché HTML.

string apply_filters( 'pom_cache_dir', string $relative_fragment )

Cambiarlo requiere que todas las rutas tempranas, de WordPress, de servidor, de estado y de eliminación coincidan.

`pom_cache_filenames`

Filtra la lista devuelta por pom_cache_get_cache_filenames().

array apply_filters( 'pom_cache_filenames', array $filenames )

La entrada incluye index.html y cualquier archivo HTML de variante de consulta para esa URL. No renombra los artefactos utilizados por el lector y el escritor; conserva la lista suministrada al ampliarla.

`pom_cache_protected_directories`

Filtra los directorios absolutos protegidos de la poda de HTML.

array apply_filters( 'pom_cache_protected_directories', array $directories )

`pom_cache_should_delete_site_cache`

Puerta compartida de alto nivel para la eliminación de HTML de todo el sitio o de un único elemento editado, y para la eliminación de JSON del sitio.

bool apply_filters(
    'pom_cache_should_delete_site_cache',
    true,
    string $context
)

`pom_cache_delete_site_cache_flush_rewrite_rules`

Controla el vaciado suave de reglas de reescritura después de la eliminación de HTML.

bool apply_filters(
    'pom_cache_delete_site_cache_flush_rewrite_rules',
    bool $should_flush,
    string $context
)

El valor predeterminado es true para manual y manual_ajax, y false para otros contextos.

`pom_cache_clear_post_cache`

Veta la limpieza automática de HTML para una entrada visible.

bool apply_filters( 'pom_cache_clear_post_cache', true, WP_Post $post )

`pom_cache_cleared`

Se ejecuta después de la limpieza de bajo nivel de la caché HTML actual/del blog.

do_action( 'pom_cache_cleared' )

No tiene argumentos.

JSON progresivo

Filtros de tiempo de ejecución, directorio y lectura

bool apply_filters( 'pom_cache_json_enabled', bool $enabled, array $context )
string apply_filters( 'pom_cache_json_cache_dir', string $path, int $blog_id )
bool apply_filters(
    'pom_cache_json_can_serve_cached_file',
    true,
    string $file,
    array $context
)

El contexto pom_cache_json_enabled está actualmente vacío. Trátalo como ampliable.

Filtro de escritura y acciones

bool apply_filters(
    'pom_cache_json_should_write',
    true,
    string $relative_path,
    string $json,
    array $context
)

do_action( 'pom_cache_json_before_write', string $file, string $json, array $context )
do_action( 'pom_cache_json_after_write', string $file, string $json, array $context )

Acciones de purga y puertas

do_action( 'pom_cache_json_before_purge', array $args )
do_action( 'pom_cache_json_after_purge', array $args, int $deleted )

bool apply_filters(
    'pom_cache_json_should_delete_site_cache',
    true,
    string $context
)

bool apply_filters( 'pom_cache_json_clear_post_cache', true, WP_Post $post )

Integración opcional de cambios de ajustes

bool apply_filters( 'pom_cache_json_purge_on_settings_changes', false )

array apply_filters(
    'pom_cache_json_framework_settings_purge_pages',
    array $page_slugs,
    string $page_slug,
    string $tab,
    string $subsection
)

Cuando está habilitada, las páginas predeterminadas observadas del POM Framework son pom-theme-options y pom-translate; guardar ajustes de búsqueda facetada también purga el JSON.

Contrato de archivo progresivo de POM Theme

POM Cache consume estos hooks públicos POM Theme:

mixed apply_filters(
    'pom_progressive_archive_cached_json',
    mixed $cached_json,
    string $relative_path,
    array $context
)

do_action(
    'pom_progressive_archive_json_generated',
    string $relative_path,
    string $json,
    mixed $response,
    array $context
)

POM Cache lee solo cuando $cached_json es null y escribe los datos generados solo cuando el contexto contiene un valor verdadero cacheable.

Consulta los artículos específicos por tema para conocer las funciones auxiliares compatibles y el uso seguro.

Invalidación exacta de HTML y protecciones de publicación

pom_cache_delete_html_urls(array $urls): bool: invalida solo archivos HTML exactos de una única página. Consulta invalidación de entradas.
pom_cache_html_purge_hosts(array $hosts): array: amplía la lista de hosts permitidos del sitio actual para la invalidación exacta de HTML.
pom_cache_publish_html(bool $allowed, string $filename, string $html): bool: veta la publicación final de HTML preservando los vetos anteriores.
pom_cache_html_publish_finished(string $filename, bool $published): libera los recursos adquiridos por la protección de publicación. Consulta filtros de búfer de salida.

Integrar la purga progresiva de JSON

Seguridad de rutas, salida y autorización