Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

Check the hook callback parameter count ?

Offen
  • Stimmt etwas nicht?
#567 0 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
25/100
Issue-Typ
Feature
Klarheit
Muss geklärt werden
Aktivitätsstatus
Veraltet
Tech-Stack
php
Bereich
tooling

Rechercherichtung

Beginnen Sie mit der Überprüfung des vorhandenen AlwaysReturnInFilter-Sniffs sowie der in den verlinkten WordPress-Referenzen dokumentierten Einstiegspunkte add_filter() und add_action(). Klären Sie, wie Callback-Deklarationen und accepted_args verglichen werden sollten, einschließlich optionaler Parameter und Closures, bevor Sie den Umfang des Sniffs festlegen. Die Aufgabe ist abgeschlossen, wenn das Verhalten für die bereitgestellten Beispiele für Verstöße und Nichtverstöße spezifiziert ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

What problem would the enhancement address for VIP?

Prevent potential fatal ArgumentCount errors.

Describe the solution you'd like

Inspired by the AlwaysReturnInFilter sniff, I was thinking that once the abstract hook/callback sniff exists, it wouldn't be that hard to create a sniff which would check synchronicity between the parameters requested from a hook-in and the callback function declaration.

This would apply to both add_filter() as well as add_action().

Such a sniff would also be a candidate for (eventually moving to) WPCS, but I wanted to discuss the general idea here first, largely to see if the potential issue described above actually occurs in real life situations.

What code should be reported as a violation?

// Error: Two parameters expected, one (implicit) requested.
add_filter( 'the_title', function( $title, $id ) {
	// Do something.
	return $title;
} );

// Warning: One parameter expected, two requested.
add_filter( 'the_title', function( $title ) {
	// Do something.
	return $title;
}, 10, 2 );

What code should not be reported as a violation?

// OK: Two parameters expected, two requested.
add_filter( 'the_title', function( $title, $id ) {
	// Do something.
	return $title;
}, 10, 2 );

// OK: Three parameters expected, two requested, but third parameter is optional,
// which can be done by design to allow direct calls to the function to pass it.
function prefix_title_filter( $title, $id, $optional = null ) {
	// Do something.
	return $title;
}
add_filter( 'the_title', 'prefix_title_filter', 10, 2 );

Additional context

Future scope
  • Once a list of WP native hooks + the amount of parameters they pass is known (via a trait in WPCS for instance), an additional check could be added that the $accepted_args parameter value is never higher than the number of passed parameters when the hook is called.
function prefix_title_filter( $title, $id, $optional = null ) {
	// Do something.
	return $title;
}

// The `the_title` filter only passes two arguments max, so the code here is an error.
add_filter( 'the_title', 'prefix_title_filter', 10, 3 );
  • For PHP native functions used in callbacks, reflection could be used to see how many (required) parameters these take and match that with the $accepted_args parameter.
  • For WP native functions a list based solution would be needed to do the same.

Relevant links

Vorherrschende Sprache
PHP
Sterne
261
Forks
44
Keine gemergten PRs in 30 T.

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus Automattic/VIP-Coding-Standards

Alle Issues in Automattic/VIP-Coding-Standards

Ähnliche Issues

Weitere Issues zu PHP

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.