Generar referencias de gancho inactivas

Parece que muchos desarrolladores de complementos se toman el tiempo para agregar ganchos de filtro / acción para permitir a los usuarios ajustar la funcionalidad de sus productos. Lo cual es genial, pero lo que a menudo no hacen es proporcionar una lista de ganchos y cuántos argumentos toman.

¿Alguien ha encontrado la mejor manera automatizada de apuntar a un directorio de plugins (o temas) y ver una lista de todos los ganchos disponibles?

Me parecen algunos complementos que escanean en busca de ganchos, pero por lo que puedo decir, te muestran cuáles están siendo llamados para representar una página determinada. Lo que consigo puede ser útil. Pero a veces, si sé que estoy interactuando con un complemento en particular, quiero saber cada lugar en el que me permita conectar una acción o filtro.

Entonces, lo que realmente estoy buscando es algo que, dado un directorio raíz del complemento, creará una lista donde cada elemento incluye:

• etiqueta
• tipo (acción o filtro)
• número de argumentos
• donde se llama (vía do_action()o apply_filter()) en la fuente

Una secuencia de comandos sería genial, ya que esto presumiblemente podría HTMLify todo y mostrarlo directamente en la interfaz de usuario de administración para cada complemento. Pero incluso un script de línea de comandos que genera un archivo estático útil sería genial.

No hay ningún script o complemento que yo sepa que haga lo que quiera. Como ha dicho, hay secuencias de comandos ( incluso variables globales ) que puede usar para imprimir filtros y acciones que se utilizan actualmente.

En cuanto a los filtros y acciones latentes, he escrito dos funciones muy básicas ( con algo de ayuda aquí y allá ), que busca todos los apply_filtersy do_actionlas instancias en un archivo y luego lo imprime

LO ESENCIAL

• Vamos a utilizar el RecursiveDirectoryIterator, RecursiveIteratorIteratory RegexIteratorlas clases PHP para obtener todos los archivos del PHP dentro de un directorio. Como ejemplo, en mi host local, he usadoE:\xammp\htdocs\wordpress\wp-includes

• Luego recorreremos los archivos y buscaremos y devolveremos ( preg_match_all) todas las instancias de apply_filtersy do_action. Lo configuré para que coincida con las instancias anidadas de paréntesis y también para que coincida con los espacios en blanco posibles entre apply_filters/ do_actiony el primer paréntesis

Simplemente crearemos una matriz con todos los filtros y acciones y luego recorreremos la matriz y mostraremos el nombre del archivo, los filtros y las acciones. Omitiremos archivos sin filtros / acciones

NOTAS IMPORTANTES

• Estas funciones son muy caras. Ejecútelos solo en una instalación de prueba local.

• Modifique las funciones según sea necesario. Puede decidir escribir la salida en un archivo, crear una página especial para eso, las opciones son ilimitadas

OPCIÓN 1

La primera función de opciones es muy simple, devolveremos el contenido de un archivo como una cadena, buscaremos file_get_contentslas instancias apply_filters/ do_actiony simplemente enviaremos el nombre de archivo y los nombres de filtro / acción

He comentado el código para seguirlo fácilmente

function get_all_filters_and_actions( $path = '' )
{
    //Check if we have a path, if not, return false
    if ( !$path ) 
        return false;

    // Validate and sanitize path
    $path = filter_var( $path, FILTER_SANITIZE_URL );
    /**
     * If valiadtion fails, return false
     *
     * You can add an error message of something here to tell
     * the user that the URL validation failed
     */
    if ( !$path ) 
        return false;

    // Get each php file from the directory or URL  
    $dir   = new RecursiveDirectoryIterator( $path );
    $flat  = new RecursiveIteratorIterator( $dir );
    $files = new RegexIterator( $flat, '/\.php$/i' );

    if ( $files ) {

        $output = '';
        foreach($files as $name=>$file) {
            /**
             * Match and return all instances of apply_filters(**) or do_action(**)
             * The regex will match the following
             * - Any depth of nesting of parentheses, so apply_filters( 'filter_name', parameter( 1,2 ) ) will be matched
             * - Whitespaces that might exist between apply_filters or do_action and the first parentheses
             */
            // Use file_get_contents to get contents of the php file
            $get_file_content =  file_get_contents( $file );
            // Use htmlspecialchars() to avoid HTML in filters from rendering in page
            $save_content = htmlspecialchars( $get_file_content );
            preg_match_all( '/(apply_filters|do_action)\s*(\([^()]*(?:(?-1)[^()]*)*+\))/', $save_content, $matches );

            // Build an array to hold the file name as key and apply_filters/do_action values as value
            if ( $matches[0] )
                $array[$name] = $matches[0];
        }
        foreach ( $array as $file_name=>$value ) {

            $output .= '<ul>';
                $output .= '<strong>File Path: ' . $file_name .'</strong></br>';
                $output .= 'The following filters and/or actions are available';
                foreach ( $value as $k=>$v ) {
                    $output .= '<li>' . $v . '</li>';
                }
            $output .= '</ul>';
        }
        return $output;
    }

    return false;
}

Puede usar a continuación en una plantilla, interfaz o backend

echo get_all_filters_and_actions( 'E:\xammp\htdocs\wordpress\wp-includes' );

Esto imprimirá

OPCION 2

Esta opción es un poco más costosa de ejecutar. Esta función devuelve el número de línea donde se puede encontrar el filtro / acción.

Aquí usamos filepara explotar el archivo en una matriz, luego buscamos y devolvemos el filtro / acción y el número de línea

function get_all_filters_and_actions2( $path = '' )
{
    //Check if we have a path, if not, return false
    if ( !$path ) 
        return false;

    // Validate and sanitize path
    $path = filter_var( $path, FILTER_SANITIZE_URL );
    /**
     * If valiadtion fails, return false
     *
     * You can add an error message of something here to tell
     * the user that the URL validation failed
     */
    if ( !$path ) 
        return false;

    // Get each php file from the directory or URL  
    $dir   = new RecursiveDirectoryIterator( $path );
    $flat  = new RecursiveIteratorIterator( $dir );
    $files = new RegexIterator( $flat, '/\.php$/i' );

    if ( $files ) {

        $output = '';
        $array  = [];
        foreach($files as $name=>$file) {
            /**
             * Match and return all instances of apply_filters(**) or do_action(**)
             * The regex will match the following
             * - Any depth of nesting of parentheses, so apply_filters( 'filter_name', parameter( 1,2 ) ) will be matched
             * - Whitespaces that might exist between apply_filters or do_action and the first parentheses
             */
            // Use file_get_contents to get contents of the php file
            $get_file_contents =  file( $file );
            foreach ( $get_file_contents as  $key=>$get_file_content ) {
                preg_match_all( '/(apply_filters|do_action)\s*(\([^()]*(?:(?-1)[^()]*)*+\))/', $get_file_content, $matches );

                if ( $matches[0] )
                    $array[$name][$key+1] = $matches[0];
            }
        }

        if ( $array ) {
            foreach ( $array as $file_name=>$values ) {
                $output .= '<ul>';
                    $output .= '<strong>File Path: ' . $file_name .'</strong></br>';
                    $output .= 'The following filters and/or actions are available';

                    foreach ( $values as $line_number=>$string ) {
                        $whitespaces = '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;';
                        $output .= '<li>Line reference ' . $line_number . $whitespaces . $string[0] . '</li>';
                    }
                $output .= '</ul>';
            }
        }
        return $output;

    }

    return false;
}

Puede usar a continuación en una plantilla, interfaz o backend

echo get_all_filters_and_actions2( 'E:\xammp\htdocs\wordpress\wp-includes' );

Esto imprimirá

EDITAR

Esto es básicamente todo lo que puedo hacer sin que los scripts excedan el tiempo de espera o se queden sin memoria. Con el código en la opción 2, es tan fácil como ir a dicho archivo y dicha línea en el código fuente y luego obtener todos los valores de parámetros válidos del filtro / acción, también, lo que es más importante, obtener la función y el contexto adicional en el que se usa el filtro / acción

Parece que WP Parser hace lo que estás buscando. Se utiliza para generar la referencia oficial del desarrollador . Enumera parámetros, etiquetas @since y referencias a la fuente. Funciona con todos los complementos de WordPress y se puede acceder a través de la línea de comandos:

wp parser create /path/to/source/code --user=<id|login>

El rápido y el furioso

La buena *nixlínea de comandos siempre es útil:

# grep  --line-number                                         \
        --exclude-dir=/path/to/some/directory                 \
        --include=*.php                                       \ 
        --recursive                                           \
        "add_filter\|do_action\|apply_filters"                \
        /path/to/wp-content/plugins/some-plugin               \ 
 | less

Muchas más opciones a través de #man grep.

Entonces incluso podemos crear un script bash simple wp-search.sh:

#!/bash/bin
grep --line-number                            \
    --exclude-dir=/path/to/some/directory     \
    --include=*.$1                            \
    --recursive $2 $3

y ejecutarlo con

 # bash wp-search.sh php "add_filter\|do_action\|apply_filters" /path/to/some-plugin

Salida bonita

Podemos usar el --coloratributo para colorear la salida de grep, pero tenga en cuenta que no funcionará con less.

Otra opción sería generar una tabla HTML para los resultados de búsqueda.

Aquí hay un awkejemplo que construí que genera los resultados de búsqueda como una tabla HTML en el results.htmlarchivo:

  | sed 's/:/: /2' \
  | awk ' \
        BEGIN { \
            print "<table><tr><th>Results</th><th>Location</th></tr>"  \
        } \
        { \
            $1=$1; location=$1; $1=""; print "<tr><td>" $0 "</td><td>" location "</td><tr>" \
        } \
        END {  \
           print "</table>" \
       }' \
 > results.html

donde utilicé este truco para eliminar todos los espacios en blanco iniciales y este para imprimir todos los campos excepto el primero.

Lo uso sedaquí solo para agregar espacio adicional después del segundo colon ( :), en caso de que no haya espacio allí.

Guión

Podríamos agregar esto a nuestro wp-search.shscript:

#!/bash/bin
grep   --with-filename \
       --line-number \
       --exclude-dir=/path/to/some/directory \
       --include=*.$1 \
       --recursive $2 $3 \
| sed 's/:/: /2' \
| awk ' BEGIN { \
        print "<table><tr><th>Results</th><th>Location</th></tr>"  \
    } \
    { \
        $1=$1; location=$1; $1=""; print "<tr><td>" $0 "</td><td>" location "</td><tr>" \
    } \
    END {  \
        print "</table>" \
    }' \
> /path/to/results.html

donde tiene que ajustar el /path/to/some/directoryy /path/to/results.htmla sus necesidades.

Ejemplo: buscar un complemento

Si intentamos esto en el wordpress-importercomplemento con:

bash wp-search.sh php "add_filter\|do_action" /path/to/wp-content/plugins/wordpress-importer/

entonces el results.htmlarchivo se mostrará como:

Ejemplo: búsqueda del núcleo

El tiempo lo probé para el núcleo:

time bash wp-search.sh php "add_filter\|do_action" /path/to/wordpress/core/

real    0m0.083s
user    0m0.067s
sys     0m0.017s

y es rapido!

Notas

Para obtener un contexto adicional, podríamos usar el -C NUMBERde grep.

Podríamos modificar la salida HTML de varias maneras, pero esperamos que pueda ajustar esto aún más a sus necesidades.