(Dieser Artikel wurde ursprünglich vom Drehmque Magazine ver?ffentlicht und mit Genehmigung nachgedruckt.)

In den letzten Jahren hat der Autor viele Artikel über objektorientierte PHP- und WordPress-REST-APIs im Drehmomentmagazin geschrieben, bei denen auch der Komponist für die Abh?ngigkeitsmanagement und die automatische Belastung sowie die Tests in Einheiten verwendet werden. Der Kernpunkt aller Artikel ist: Durch die Anwendung etablierter Softwareentwicklung Best Practices auf WordPress -Entwicklung k?nnen wir bessere Plugins erstellen.

Dies ist das erste in einer Reihe von Artikeln, die diese Konzepte in ein praktisches, funktionales Beispiel integrieren. Ich werde durch das Erstellen eines WordPress -Plugins gehen, um die Funktionalit?t des WordPress -REST -API -Endpunkts zu ?ndern, um die Suche besser zu optimieren. Das Plugin ist auf GitHub erh?ltlich. M?glicherweise müssen Sie das Commit -Protokoll durchsuchen, um meinen Erstellungsprozess zu verstehen.

In dieser Serie werde ich mithilfe moderner objektorientierter PHP und wie man es testbar erstellt und wie man automatisierte Tests dafür schreibt. Ich werde die Unterschiede zwischen Unit -Tests, Integrationstests und Akzeptanztests abdecken und Ihnen zeigen, wie Sie jeden Testtyp schreiben und automatisieren. In diesem Artikel wird zun?chst vorgestellt, wie eine objektorientierte Methode verwendet wird, um die WordPress-REST-API mit Filtern zu ?ndern.

Schlüsselpunkte

• Verbesserung der WordPress-REST-API-Endpunkte mit objektorientiertem PHP für bessere Suchfunktionen und integrieren Sie in erweiterte Suchwerkzeuge wie Elasticsarch.
• ?ndern Sie die REST -API -Endpunktparameter und die WP_Query -Interaktion, um die Einschr?nkungen der Standard -WordPress -Suche zu umgehen und die Antwortqualit?t komplexer Abfragen zu verbessern.
• Verwenden Sie Unit-Tests, Integrationstests und Akzeptanztests für einen robusten und leicht zu machtenden Code, um sicherzustellen, dass jede Komponente im WordPress-?kosystem korrekt ausgeführt wird.
• Verwenden Sie die Abh?ngigkeitsinjektions- und PHP -Merkmale, um Klassenabh?ngigkeiten sauber zu verwalten, und erm?glichen Sie eine einfachere Wartungs- und Testcode.
• Passen Sie den REST -API -Endpoint -Modus an, um zus?tzliche Parameter wie post_type zu berücksichtigen, die flexiblere und leistungsf?higere Suchfunktionen erm?glichen.
• passen Sie die Parameter WP_Query dynamisch durch bestimmte REST -API -Anforderungen an und verwenden Sie Filter, um die Suchergebnisse und das Endpunktverhalten effektiv zu verfeinern.

WordPress -Suche mit REST -API

Verwenden Sie normalerweise Plugins wie SearchWP oder Relevansi oder Integration in Elasticsearch (eine Technologie, die einen v?llig anderen Stack von WordPress verwendet), um die WordPress -Suche zu verbessern. Diese Arten von Plugins liefern bessere Suchergebnisse und werden h?ufig mit einer vielf?ltigen Suchschnittstelle verwendet, die für E-Commerce-Anwendungen sehr nützlich ist.

Durchsuchen Sie die WordPress Rest -API erbt all diese Probleme und dieselben L?sungen. In diesem Beitrag werde ich zun?chst vorstellen, wie die Suche funktioniert und ihre Grenzen. Wir werden uns dann ansehen, wie Sie Suchvorg?nge ?ndern und mit zwei verschiedenen Methoden in SearchWP integrieren.

Die integrierte Suchfunktion von WordPress erfordert normalerweise eine Verbesserung mit externen Diensten. W?hrend es in diesem Artikel um einen objektorientierten Ansatz zur ?nderung des WordPress-REST-API-Routings geht, w?re das tats?chliche Beispiel, die Suche zu verbessern.

Wenn WordPress als Backend für die Entkopplung von Frontenden (z. API. Der in diesem Artikel vorgestellte Code hilft Ihnen, wenn Ihre Anwendungsbenutzer die richtige Produktvariante finden oder nach Inhalten basierend auf komplexen Algorithmen basierend auf mehreren Taxonomie suchen müssen. Sie schreiben benutzerdefinierten Code, anstatt nur Plugins zu installieren.

Suchbeitr?ge mit WordPress Rest API

Wenn Sie auf einer Site nach allen Beitr?gen mit einem Post -Art von ?Produkt“ suchen m?chten, verwenden Sie den Suchbegriff ?Taco -Shirts“ und Sie stellen eine Anfrage an den /wp/v2/product?s=Taco Shirt -Dendpunkt. Wenn Sie die Qualit?t Ihrer Ergebnisse verbessern m?chten, helfen die oben aufgeführten L?sungen.

Wie oben erw?hnt, ist WP_Query (die vom Postendpunkt der WordPress -REST -API verwendet) kein gutes Suchwerkzeug. Insbesondere ist WP_Query weniger wahrscheinlich als dedizierte Suchwerkzeuge, die aufgrund seiner Abh?ngigkeit von MySQL mithilfe von NoSQL -Datenbanken erstellt werden.

Erstens sehen wir, wie die Interaktion von WP_Query mit der WordPress -Datenbank umgeht, wenn Sie REST -API -Anforderungen erstellen.

Dies ist eine Strategie, die von vielen Such -Plugins verwendet wird, um ihre eigenen Suchsystemergebnisse zu ersetzen (die standardm??ig für WP_Query generiert werden). Das Suchsystem kann dieselbe Datenbank verwenden. Es kann auch eine Verbindung zu anderen Datenbanken herstellen, m?glicherweise über API -Anforderungen, z. B. über Elasticsearch- oder Apache -Solr -Server.

Wenn Sie sich den WordPress -Core -Code ansehen, werden Sie feststellen, dass der Filter "posts_pre_query" vor der WP_Query -Abfragedatenbank ausgeführt wird, aber nachdem die SQL -Abfrage fertig ist. Dieser Filter gibt standardm??ig Null zurück. Wenn der Wert null ist, setzt WordPress sein Standardverhalten fort: Fragen Sie die WordPress -Datenbank ab und geben Sie das Ergebnis als einfaches Array von WP_POST -Objekten zurück.

Andererseits wird das Standardverhalten von WordPress nicht verwendet, wenn der Rückgabewert dieses Filters ein Array ist (das ein WP_POST -Objekt enthalten m?chte).

Lassen Sie uns sehen, wie Sie posts_pre_query verwenden, um einen simulierten WP_POST zurückzugeben. Diese Strategie ist sehr nützlich für das Testen, aber eine komplexere Version desselben Schemas kann verwendet werden, um eine separate Datenbank in Ihre WordPress -Site zu integrieren:

// ... (代碼示例與原文相同) ...

In diesem Beispiel verwenden wir Scheindaten, k?nnen jedoch die Abfrageklasse von SearchWP oder irgendetwas anderes verwenden. Eine andere Sache, die zu diesem Code zu beachten ist, ist, dass er auf einer WP_QUERY ausgeführt wird, nicht nur auf dem von der WordPress -Rest -API erstellten WP_Query -Objekt. ?ndern wir es so, dass wir keine Filter verwenden, es sei denn, es handelt sich um eine WordPress -REST -API -Anfrage:

// ... (代碼示例與原文相同) ...

WordPress Rest API -Endpunktparameter

Wir haben uns nur angesehen, wie die Suchergebnisse für WordPress -REST -API -Anforderungen ge?ndert werden. Dies erm?glicht es uns, die Abfrage für bessere Suchergebnisse zu optimieren, kann jedoch die Notwendigkeit verschiedener Muster des Endpunkts aufdecken.

Wenn Sie beispielsweise die Suche nach Produktendpunkten zulassen m?chten, k?nnen Sie optional andere Post -Typen in die Suche einbezogen werden, habe ich letztes Jahr eine weitere L?sung für dasselbe Problem eingeführt.

horizontaler Fokus

wir sehen uns an, wie die zul?ssigen Endpunktparameter ?ndert und wie Sie sie verwenden, um WP_Query -Parameter zu erstellen. Dies sind zwei getrennte Bedenken, und das Prinzip der einzigen Verantwortung besagt, dass wir für jedes Problem eine Klasse schaffen müssen. Diese beiden Klassen werden jedoch Bedenken geteilt haben.

Wenn wir beispielsweise das Abfragen nach verschiedenen Post -Typen zulassen m?chten, müssen wir wissen, welche ?ffentlichen Post -Typen sind und welche Slug- und REST_BASE -Parameter sind. Alle diese Informationen sind über die Funktion get_post_types verfügbar.

Die Ausgabe dieser Funktion ist nicht genau das, was wir brauchen. Entwerfen wir also eine Klasse, um die Daten gem?? den gerade aufgeführten Anforderungen zu formatieren, und bieten uns eine Helfermethode, um darauf zuzugreifen.

Stellen Sie sich dies als eine gemeinsame Form für alle Post -Typ -Daten vor, die wir in verfügbaren Containern verwenden müssen:

// ... (代碼示例與原文相同) ...

Beachten Sie, dass wir in der Klasse anstatt get_post_types () aufzurufen, es als Abh?ngigkeit verwenden, die durch den Konstruktor injiziert wird. Daher kann diese Klasse getestet werden, ohne WordPress zu laden.

Deshalb beschreibe ich diese Art als "Einheitstestbar". Es ist nicht auf eine andere API angewiesen, und wir machen uns keine Sorgen um Nebenwirkungen. Wir k?nnen es als separate, isolierte Einheit testen. Trennen Sie den Fokus und isolieren seine Funktionalit?t in kleine Teile. Sobald wir die Abdeckung der Unit -Tests haben, k?nnen wir den Code einfach machen. Ich werde in meinem n?chsten Beitrag abdecken, wie ich diese Art von Unterricht testen kann.

Denken Sie daran, dass diese Klasse von wp_post_type abh?ngt. Meine Unit -Tests definieren die Klasse nicht, da nur Integrationstests WordPress oder andere externe Abh?ngigkeiten verwenden k?nnen. Diese Klasse wird nur zur Darstellung von Daten verwendet, um keine Aktion auszuführen. Daher k?nnen wir sagen, dass seine Verwendung keine Nebenwirkungen hat. Daher würde ich gerne Mocks in Unit -Tests anstelle von echtem WP_POST_TYPE verwenden.

Apropos Abh?ngigkeitsinjektion, Klassen, die Objekte dieser neuen Klasse erfordern, m?chten dem gleichen Muster folgen. Anstatt vorbereitete POSTTYPES in der Klasse zu instanziieren, die sie ben?tigt, passieren wir in einem Fall. Dies bedeutet, dass Klassen mit vorbereiteten postypen und propostPostype isoliert gehalten werden und separat getestet werden k?nnen.

Es kann auch eine Wiederverwendung von Codeen verursachen, da wir eine Abh?ngigkeitsinjektion erm?glichen und eine Eigenschaft für dieses Objekt festlegen müssen. Wir k?nnen Schnitt- und Einfügen verwenden oder PHP -Merkmale, eine fortschrittlichere und erweiterbare Methode zum Kopieren von Methoden und Eigenschaften zwischen Klassen.

Dies ist ein Merkmal, das ein Muster für die Injektion von propostPostypes -Objekten in andere Klassen festlegt:

// ... (代碼示例與原文相同) ...

Eine unserer Bedenken ist, dass wir einige Informationen über den Post -Typ an mehreren Stellen kennen. Zum Beispiel Post -Typ -Schlupf. Dies unterscheidet sich geringfügig von den vorherigen überg?ngen. Das letzte Problem, das wir gel?st haben, beinhaltet dynamische Daten. Jetzt müssen wir nur noch die Saiten ?ndern, die wir an mehreren Stellen an einem Ort verwenden.

Eine Klasse mit Klassenkonstanten l?ste dieses Problem für uns einfach:

// ... (代碼示例與原文相同) ...

Jetzt k?nnen wir diese Zeichenfolgen im gesamten Code konsistent machen. Dies scheint ein unn?tiger Schritt zu sein. Mein Beispielcode funktioniert jedoch für den Post -Post -Typ. Wenn Sie den von Ihnen verwendeten Post -Typ ?ndern m?chten, muss diese Klasse ge?ndert werden, ohne etwas anderes zu ?ndern. Dies folgt Tom McFarlins bevorzugte Definition des Prinzips der einzigen Verantwortung, als er schrieb: "Eine Klasse sollte nur einen Grund haben, sich zu ?ndern."

REST -API -Endpunktmodus

Jetzt müssen wir das Muster des Post -Typ -Endpunkts ?ndern. Auf diese Weise kommuniziert WordPress dem Rest -API -Endpunkt, dass der Post -Typ -Parameter zul?ssig ist und dass neue Endpunktparameter bei der Anforderung zul?ssig sind.

Dies ist unsere Klasse, um die Eigenschaft post_type hinzuzufügen. Bitte beachten Sie, dass das Merkmal verwendet wird, um angemeldetesPostypen zu verwenden, die wir gerade besprochen haben:

// ... (代碼示例與原文相同) ...

In den Einstellungen dieser Eigenschaft teilen wir WordPress mit, dass diese Eigenschaft eine Array -Eigenschaft ist, und wir verwenden den "Enum" -Dex des Arrays, um die zul?ssigen Werte anzugeben.

In "Enum" sind wir zul?ssige Werte aufz?hlt. In diesem Fall liefert die vorbereitete POSTTYPES-Klasse eine Reihe von zul?ssigen Werten, da dies ein zuvor gel?stes übergangsanliegen ist.

Beachten Sie, dass diese Klasse nicht an einen Post -Typ oder sogar diesen speziellen Anwendungsfall gekoppelt ist. Wir werden bald zu den Haken zurückkehren, damit diese Klasse für bestimmte Post -Typen funktioniert.

REST -API WP_QUERY -Parameter

Der vorherige Abschnitt beschreibt, wie die neue Endpoint -Eigenschaft post_type verfügbar ist. Dies ?ndert den Parameter WP_Query nicht tats?chlich, der von der WordPress -REST -API erzeugt wird. Wir haben bereits alles, was wir brauchen, au?er dem letzten Filter.

Post -Typ ist ein WP_Query -Parameter, den der Kerncode speziell keine ?nderungen an der REST -API -Anforderung zul?sst. Wir haben einen dynamisch benannten Filter - REST _ {$ post_type} _query - k?nnen jeden Parameter WP_Query überschreiben.

Dies ist unsere Klasse, die unsere post_type -Parameter injiziert, die vorher nicht zul?ssig waren:

// ... (代碼示例與原文相同) ...

Das meiste davon ist nur zu überprüfen, ob wir ?nderungen vornehmen und dann die Get_param -Methode von wp_rest_request verwenden sollten, um den Wert aus der Anforderung zu erhalten. Das meiste davon ist automatisch, da wir das Muster zuerst ?ndern.

?ndern Sie das von WordPress Rest API angeforderte WP_Query -Objekt

Ich habe bereits im ersten Teil dieses Artikels darüber gedeckt, wie dies zu tun ist. Dies ist eine Klasse, die dasselbe Muster implementiert:

// ... (代碼示例與原文相同) ...

Ich hoffe, Sie bemerken, dass dieser Code eng mit WordPress zusammenh?ngt und nicht überprüfbar ist. Es verwendet WP_POST von WordPress, bei dem Konstanten für WordPress überprüft und mit der Plugin -API von WordPress interagiert. Wir k?nnen WP_POST simulieren und Konstanten selbst festlegen. Aber die API des Plugins - dies ist eine wichtige Funktion, die getestet werden muss. In meinen n?chsten Beitr?gen werde ich so abdecken, wie diese Klasse neu gestaltet werden kann, damit wir Unit -Tests verwenden k?nnen, um alles au?er dem Effekt des Entfernens dieses Filters abzudecken und Integrationstests zu überprüfen, um diesen Effekt zu überprüfen.

Ich habe aus zwei Gründen eine statische Methode verwendet. Erstens erleichtert es einfach, es an mehreren Stellen hinzuzufügen und zu entfernen. In der ModifyQuery -Klasse bin ich beispielsweise nur bei Bedarf diesen Filter an:

// ... (代碼示例與原文相同) ...

Au?erdem ist es einfach, bei Verwendung dieses Filters rekursive Schleifen zu erstellen. Es ist gro?artig, es so einfach entfernen zu k?nnen wie in diesem Beispielcode.

Ein weiterer Grund, warum ich eine statische Methode verwendet habe, ist, dass die Funktion mit anderen APIs interagiert. Es wird niemals wirklich einheitstestbar sein. Dieses Muster, eine Klasse mit statischen Methoden, macht es sehr einfach, die Klasse in Integrationstests zu simulieren, wodurch die Auswirkung einer starken Isolation in einem Teil dieses Systems minimiert wird.

Lassen Sie alle Inhalte zusammenarbeiten

Der Code, den wir bisher gesehen haben, ist sehr aus WordPress entdeckt. Dies gibt viele Vorteile. Aber das bedeutet, dass es nichts von selbst tut. Das ist sehr gut. Wir haben uns bisher nur mit den Anforderungen an die Gesch?ftslogik befasst. Jetzt müssen wir die Integration berücksichtigen.

Dies ist nicht schwierig, fügen Sie einfach einige Haken hinzu. Welche Haken? Genau die gleichen zwei Haken wie für die ModifyQuery- und ModifySchema -Klassen. Der Wunsch nach Entkopplung der Gesch?ftslogik bedeutet nicht, dass wir die tats?chlichen Gründe nicht berücksichtigen k?nnen, warum wir beim Entwerfen ihrer ?ffentlichen Schnittstellen Code schreiben. Andernfalls werden wir unserem Code nur ohne Grund eine zus?tzliche Komplexit?t hinzufügen.

Im Allgemeinen versuche ich, die Komplexit?t der Software nur dann zu erh?hen, wenn es das Leben erleichtert. Ich habe in der Vergangenheit von diesem Weg abgewichen. Wir alle haben es, es spielt keine Rolle, üben Vergebung.

Die Methoden in der Klasse, die wir kurz vor dem Haken sind, verwenden genau die gleichen Parameter und Rückgabetypen wie der Haken. Ihre Aufgabe ist es, diese Werte anderen Komponenten zuzuweisen.

// ... (代碼示例與原文相同) ...

N?chster Schritt: Test

Das ist nah genug. Es wird funktionieren. Aufgrund des Fehlens eines formalen Systems zum Hinzufügen von Haken ist dies das Beste, was wir für die Initialisierung tun k?nnen. Das ist sehr gut. Ich werde in einem zukünftigen Artikel zu WordPress -Integrationstests einen komplexeren und skalierbaren Startprozess erstellen.

In diesem Artikel untersuchen wir die zugrunde liegende WP_Query für das Erstellen von Code zum ?ndern von Schema, WP_Query -Parametergenerierung und Post -Typ. Ich ermutige Sie, diesen Code in ein Plugin umzuwandeln und Komponist zum automatischen Laden zu verwenden. In meinem n?chsten Beitrag werden wir uns mit Unit -Tests befassen, um diese Klassen abzudecken.

(Folgendes ist der ursprüngliche FAQ

Was bedeutet objektorientierte Programmierung (OOP) in WordPress?

Das obige ist der detaillierte Inhalt vonErweiterte OOP für WordPress: Anpassen von REST -API -Endpunkten. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!