Skip to content

include hooks/actions called by scheduled functions #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: trunk
Choose a base branch
from
Open

include hooks/actions called by scheduled functions #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 80 additions & 0 deletions src/generate.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,17 +126,29 @@ function hooks_parse_files( array $files, string $root, array $ignore_hooks ) :
$file_hooks = array_merge( $file_hooks, export_hooks( $file->uses['hooks'], $path ) );
}

if ( ! empty( $file->uses['functions'] ) ) {
$file_hooks = array_merge( $file_hooks, export_scheduled_hooks( $file->uses['functions'], $path ) );
}

foreach ( $file->getFunctions() as $function ) {
if ( ! empty( $function->uses ) && ! empty( $function->uses['hooks'] ) ) {
$file_hooks = array_merge( $file_hooks, export_hooks( $function->uses['hooks'], $path ) );
}

if ( ! empty( $function->uses ) && ! empty( $function->uses['functions'] ) ) {
$file_hooks = array_merge( $file_hooks, export_scheduled_hooks( $function->uses['functions'], $path ) );
}
}

foreach ( $file->getClasses() as $class ) {
foreach ( $class->getMethods() as $method ) {
if ( ! empty( $method->uses ) && ! empty( $method->uses['hooks'] ) ) {
$file_hooks = array_merge( $file_hooks, export_hooks( $method->uses['hooks'], $path ) );
}

if ( ! empty( $method->uses ) && ! empty( $method->uses['functions'] ) ) {
$file_hooks = array_merge( $file_hooks, export_scheduled_hooks( $method->uses['functions'], $path ) );
}
}
}

Expand Down Expand Up @@ -167,6 +179,74 @@ function hooks_parse_files( array $files, string $root, array $ignore_hooks ) :
return $output;
}

/**
* @param \WP_Parser\Function_Call_Reflector[] $nodes Array of hook references.
* @param string $path The file path.
* @return array<int,array<string,mixed>>
*/
function export_scheduled_hooks( array $nodes, string $path ) : array {
$out = array();

$event_functions = [
'wp_schedule_event',
// WooCommerce action scheduler
'as_schedule_recurring_action',
'as_schedule_cron_action',
];

$single_event_functions = [
'wp_schedule_single_event',
// WooCommerce action scheduler
'as_schedule_single_action',
'as_enqueue_async_action',
];

foreach ( $nodes as $wp_node ) {
if ( !$wp_node instanceof \WP_Parser\Function_Call_Reflector ) {
continue;
}

$origNode = $wp_node->getNode();

// same code used in psalm-plugin-wordpress
if ( $origNode instanceof \PhpParser\Node\Expr\FuncCall && $origNode->name instanceof \PhpParser\Node\Name ) {
if ( in_array( (string) $origNode->name, $event_functions, true ) ) {
$hook_type = 'cron-action';
// the 3rd arg (index key 2) is the hook name
$hook_index = 2;
} elseif ( in_array( (string) $origNode->name, $single_event_functions, true ) ) {
$hook_type = 'cron-action';
$hook_index = 1;

if ( (string) $origNode->name === 'as_enqueue_async_action' ) {
$hook_index = 0;
}
} else {
continue;
}

if ( ! $origNode->args[ $hook_index ]->value instanceof \PhpParser\Node\Scalar\String_ ) {
continue;
}

$out[] = array(
'name' => $origNode->args[ $hook_index ]->value->value,
'file' => $path,
'type' => 'action',
'doc' => array(
'description' =>'',
'long_description' => '',
'tags' => array(),
'long_description_html' => '',
),
'args' => 0,
);
}
}

return $out;
}

/**
* @param \WP_Parser\Hook_Reflector[] $hooks Array of hook references.
* @param string $path The file path.
Expand Down