Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Add filter for skipping files earlier in the pipeline than 'wp_parser_pre_import_file'

Abierto
#198 3 comentarios 2 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
42/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
php

Línea de trabajo

Comienza en WP_Parser\get_wp_files() y compara su flujo de descubrimiento de archivos con el filtro wp_parser_pre_import_file existente en WP_Parser\Importer::import_file(). Añade el filtro anterior con los argumentos de archivo y directorio propuestos, y confirma que los archivos rechazados allí no se analizan ni se importan.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

enhancement

\\WP_Parser\Importer::import_file() provides the wp_parser_pre_import_file filter to skip importing a particular file.

It would improve efficiency if there were a similar filter earlier in the pipeline, e.g., in \\WP_Parser\get_wp_files(). For example,

function get_wp_files( $directory ) {
	$iterableFiles = new \RecursiveIteratorIterator(
		new \RecursiveDirectoryIterator( $directory )
	);
	$files         = array();

	try {
		foreach ( $iterableFiles as $file ) {
			if ( 'php' !== $file->getExtension() ) {
				continue;
			}

			if ( ! apply_filters( 'wp_parser_pre_get_wp_file', true, $file->getPathname(), $directory ) ) {
				continue;
			}

			$files[] = $file->getPathname();
		}
	} catch ( \UnexpectedValueException $exc ) {
		return new \WP_Error(
			'unexpected_value_exception',
			sprintf( 'Directory [%s] contained a directory we can not recurse into', $directory )
		);
	}

	return $files;
}

I use this plugin to produce developer documentation for plugins/themes I create for clients, and currently hook into wp_parser_pre_import_file to skip importing anything in tests/ or vendor/ sub-dirs of a plugin/theme. Having the proposed wp_parser_pre_get_wp_file hook would allow avoiding the overhead of parsing all those files, only to skip them later in the pipeline.

Here is an example of a func I would hook into the proposed filter, to show why the proposed filter takes the additional $directory param that wp_parser_pre_import_file does not:

add_filter( 'wp_parser_pre_get_wp_file', 'shc_wp_parser_skip_files', 10, 3 );

function shc_wp_parser_skip_files( $default, $file, $directory ) {
	$file = str_replace( $directory . DIRECTORY_SEPARATOR, '', $file );
	$paths = explode( DIRECTORY_SEPARATOR, $file );
	if ( in_array( $paths[1], array( 'tests', 'vendor' ) ) ) {
		return false;
	}

	return $default;
}
Lenguaje dominante
PHP
Estrellas
239
Forks
81
Merge medio
16 h 29 min
PR fusionados (30 d)
8

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de WordPress/phpdoc-parser

Todos los issues de WordPress/phpdoc-parser

Issues similares

Más issues de PHP

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.