הבנת הוקים בוורדפרס: מדריך לשימוש ב- Actions ו- Filters

אם אתם מפתחים בוורדפרס, הוקים הם אחד הקונספטים הראשונים שעליכם לשלוט בהם. מכיוון ששינוי קבצי הליבה של וורדפרס אסור בהחלט, הוקים הם הדרך להתאים התנהגות. הם מאפשרים למפתחים להצמיד קוד משלהם לליבה של וורדפרס, לתבניות ולתוספים.

במדריך זה נסביר מהם הוקים, נכסה את שני הסוגים (פעולות ופילטרים), נעבור על דוגמאות מעשיות, ונראה כיצד ליצור הוקים משלכם.

הסבר על המונחים

הוק (Hook) הוא מונח גנרי בוורדפרס המתייחס למיקומים בהם ניתן, או להוסיף קוד משלכם או לשנות את הפעולות אותן וורדפרס מבצעת או מדפיסה כברירת מחדל. קיימים שני סוגים של הוקים והם Actions & Filters. לצורך הנוחות נתייחס אליהם בפוסט זה כפעולות ופילטרים.

פעולה (Action)

פעולה בוורדפרס היא הוק המתבצע בזמן ספציפי כאשר וורדפרס רצה ומאפשר לכם לבצע פעולה מסוימת באותו זמן. פעולה למשל יכולה להיות יצירת פוסט מותאם אישית (Custom Post Type) כאשר וורדפרס מאותחלת או אף שיתוף הפוסט שלכם בפייסבוק כאשר אתם מפרסמים פוסט.

בעבודה עם פעולה אתם לא מקבלים או משנים מידע, אלא פשוט מקבלים מקום להוסיף ולהריץ קוד משלכם בזמן מסוים במהלך הריצה של וורדפרס (WordPress Runtime).

פילטר (Filter)

פילטר מאפשר לכם לשנות מידע לפני שהוא נשלח למסד הנתונים או לדפדפן. לדוגמה, ניתן להוסיף תוכן בסוף כל פוסט או לשנות את אורך התקציר.

העבודה עם הוקים מתחילה בזיהוי ההוק שאליו צריך להצמיד את הקוד, ולאחר מכן כתיבת הפונקציה שמשנה מידע (פילטר) או מבצעת פעולה.

כיצד להצמד להוקים או להסיר צימוד להוקים?

הצמדת פונקציות משלכם היא פשוטה. עבור פעולות, אתם צריכים את שם ההוק ומתי עליו לרוץ. עבור פילטרים, צריך לדעת גם איזה סוג ערך מתקבל ומה צריך להחזיר.

כיצד להצמד לפעולה

add_action( $hook, $function_to_add, $priority, $accepted_args );

הפרמטרים הדרושים לפונקציה add_action הינם ההוק אליו אתם מעוניינים להצמד ושם הפונקציה שברצונכם להצמיד אליו.

הפרמטר priority הוא אופציונלי (ברירת מחדל 10) ושולט בסדר הביצוע – מספרים נמוכים יותר רצים ראשונים. הפרמטר $accepted_args מציין כמה ארגומנטים הפונקציה מקבלת.

לידיעתכם, פרמטר ה priority כברירת המחדל שלו הוא 10.

כיצד להצמד לפילטר

add_filter( $tag, $function_to_add, $priority, $accepted_args );

הפונקציה add_filter עובדת בצורה זהה כמו add_action, אך זכרו כי עבור פילטר – על הפרמטר function_to_add לקבל ערך ולהחזיר אותו בסוף הפונקציה.

כיצד להסיר צימוד להוקים

השתמשו ב-remove_action() או remove_filter() עם שם ההוק, שם הפונקציה והעדיפות. העדיפות חייבת להתאים לזו שהוגדרה כשהפונקציה הוצמדה במקור.

remove_action( $tag, $function_to_remove, $priority );

remove_filter( $tag, $function_to_remove, $priority );

לאחר שהבנו את הבסיס של כיצד להסיר ולהצמיד פונקציות, בואו ניתן מבט במספר דוגמאות מהעולם האמיתי של מספר הוקים בפעולה.

דוגמאות שימוש בהוקים – וורדפרס

בוורדפרס ישנם מאות הוקים מובנים, ותוספים ותבניות מוסיפים משלהם. להלן דוגמאות מעשיות עם הוקים של ליבת וורדפרס ושל התוסף Yoast SEO.

1. הוספת קישור לעמוד הבית בפוטר (footer)

<?php
/****** BEGIN HERE ******/
function add_footer_link() { ?> 
 <a href="https://savvy.co.il">Savvy.co.il - WordPress Developer &amp Designer</a>
<?php
}
add_action( 'wp_footer', 'add_footer_link' );

2. שינוי אורך התקציר (excerpt)

function excerpt_length_example( $words ) {
 return 15;
}
add_filter( 'excerpt_length', 'excerpt_length_example' );

בדוגמא זו אנו נצמדים להוק (פילטר) בשם excerpt_length המספק לנו מספר (שלם) הקובע את מספר המילים שיופיע כשאשר משתמשים בפונקציה the_excerpt() בתבנית שלכם.

אם אינכם בטוחים איזה סוג ערך הפילטר אמור לקבל, חפשו בקוד הליבה של וורדפרס את apply_filters( 'filter_name' ותנו מבט עמוק יותר במה שקורה עם אותו פילטר.

3. להצמד לשלב בו מפרסמים פוסט

function publish_post_tweet($post_ID) {
 global $post;
 // Code to send a tweet with post info
}
add_action('publish_post', 'publish_post_tweet');

הוק זה נצמד לפעולה publish_post שמופעלת כאשר פוסט מפורסם. ניתן להשתמש בו להפעלת כל לוגיקה בשלב זה, כמו שליחת התראה או שיתוף ברשתות חברתיות.

4. להצמד לשלב בו מוסיפים נכסים (סקריפטים וקבצי CSS)

function themeslug_enqueue_style() {
	wp_enqueue_style( 'core', 'style.css', false ); 
}

function themeslug_enqueue_script() {
	wp_enqueue_script( 'my-js', 'filename.js', false );
}

add_action( 'wp_enqueue_scripts', 'themeslug_enqueue_style' );
add_action( 'wp_enqueue_scripts', 'themeslug_enqueue_script' );

אני מניח שראיתם משהו דומה לקוד הבא ברבים מהמאמרים בבלוג זה. הוא נמצא בשימוש רבות ולומדים אותו בשלב מאוד מוקדם בעולם של פיתוח וורדפרס. במקרה זה אנו נצמדים להוק (פעולה) בשם wp_enqueue_scripts בכדי להוסיף נכסים – קבצי Javascript וקבצי CSS בצד לקוח (Frontend) בתבנית הוורדפרס שלכם. זוהי הדרך המועדפת להוסיף נכסים באתרי וורדפרס ונכונה יותר מאשר ״תכנות נוקשה״ הלא הוא hard coding.

זה המקום לציין, אם לא הייתי ברור – ניתן להצמיד כמה פונקציות שתרצו לאותו הוק!

5. הוספת מספר העמוד בכותרת המטא הנוצרת על ידי Yoast SEO

כפי שהזכרנו בתחילת המאמר, תוספים רבים מספקים לנו הוקים על מנת לבצע מודיפיקציה לפונקציונליות שלהם.

function change_yoast_title($title) {
 $paged = (get_query_var('paged')) ? get_query_var('paged') : 1;
 if ( is_paged() ) {
 return $title . ' - Page ' . $paged;
 }
 else {
 // first page of pagination
 return $title;
 }
}
add_filter('wpseo_title','change_yoast_title');

במקרה אמיתי זה, איש הקידום של אחת החברות להן אני מספק שירות, ביקש להוסיף בעמודים הממוספרים (paginated pages) של האתר את המילה Page ומספר העמוד בסופה של כותרת המטא (meta title) באותם עמודים.

לדוגמה, בעמוד שלוש יופיע Page 3 בסוף כותרת המטא וכנ״ל לגבי הכותרות בשאר העמודים הממוספרים, כל זאת כאשר בעמוד מספר אחד שינוי זה לא יתבצע. מכיוון ובמקרה של אותו אתר ספציפי כותרת המטא נוצרה באמצעות התוסף WordPress SEO by Yoast, נכון היה לחפש פילטר של Yoast המאפשר לבצע מודיפיקציה לכותרת העמוד.

חיפוש זריז הוביל להוק (פילטר) בשם wpseo_title המקבל כערך את כותרת העמוד ומחזיר את הכותרת לאחר השינוי שביצעתם. יצרנו פונקציה בשם change_yoast_title בה אנו בודקים האם העמוד ממוספר או לא, ובמידה וכן תוסיף את הטקסט המבוקש בסוף הכותרת.

6. הסרת כתובות קנוניות מעמודי תוצאות החיפוש באתר שלכם

פעולה שמקדמי אתרים יאהבו סביר להניח. בהנחה ואתם משתמשים ב Yoast SEO הפילטר הבא יסיר את הכתובת הקנונית (Canonical URL) מעמודי תוצאות החיפוש של וורדפרס:

function yoast_remove_canonical_search( $canonical ) {
	if( is_search() ) {
		return false;
	} else {
		return $canonical;
	}
}
add_filter('wpseo_canonical', 'yoast_remove_canonical_search');

פונקציות שימושיות לבדיקת הוקים

וורדפרס מספקת מספר פונקציות לבדיקה ודיבוג של הוקים בזמן ריצה:

• has_filter( $hook, $callback ) – בדיקה אם פונקציה מסוימת מוצמדת להוק. עובד גם עבור פעולות וגם עבור פילטרים.
• did_action( $hook ) – מחזיר את מספר הפעמים שפעולה הופעלה. שימושי למניעת ביצוע כפול.
• current_action() / current_filter() – מחזיר את שם ההוק שמתבצע כרגע.
• remove_all_actions( $hook ) / remove_all_filters( $hook ) – מסיר את כל הפונקציות המוצמדות להוק מסוים.

יצירת הוקים (משלכם)

יצירת הוקים משלכם היא פשוטה. השתמשו ב-do_action() עבור פעולות מותאמות וב-apply_filters() עבור פילטרים מותאמים.

1. הגדירו את ההוק שלכם

הוסיפו את הקוד הבא לקובץ functions.php (או לתוסף שלכם):

function custom_hook() {
 do_action('custom_hook');
}

הקוד המופיע מעלה יוסיף פעולה בשם custom_hook לספריית ההוקים של וורדפרס ויאפשר לכם להשתמש בו בכל מקום שתרצו בתבנית שלכם. כמובן, שעליכם לקרוא להוק בשם הגיוני יותר המתאר את הפונקציה המתבצעת.

2. הוסיפו את ההוק בתבנית שלכם

הוסיפו את הקריאה לפונקציה היכן שתרצו בתבנית שלכם:

<?php custom_hook(); ?>

ניתן אגב פשוט להוסיף את do_action('custom_hook'); בתבנית ישירות.

התבנית שלכם כעת מצוידת בהוק מותאם. כל מפתח יכול להצמיד אליו פונקציות באמצעות add_action().

3. הוסיפו את הפונקציה עצמה

כעת, בכדי להוסיף קוד משלכם במיקום זה עליכם להשתמש בקוד הבא:

if ( ! function_exists( 'your_function_name' ) ) {
 function your_function_name() {
 // Your custom code goes here
 }
 add_action( 'custom_hook', 'your_function_name' );
}

שימו לב כי עטפנו את הפונקציה ב-function_exists() כדי למנוע שגיאות במקרה שכבר קיימת פונקציה בשם זה.

4. יצירת פילטר מותאם

ניתן גם ליצור פילטרים מותאמים באמצעות apply_filters():

function get_custom_greeting( $name ) {
 $greeting = 'Hello, ' . $name;
 return apply_filters( 'custom_greeting', $greeting, $name );
}

מפתחים אחרים יכולים כעת לשנות את הברכה:

function modify_greeting( $greeting, $name ) {
 return 'Welcome, ' . $name . '!';
}
add_filter( 'custom_greeting', 'modify_greeting', 10, 2 );

שאלות נפוצות

סיכום

הוקים הם הבסיס להרחבת וורדפרס. פעולות מאפשרות להריץ קוד בנקודות ספציפיות, ופילטרים מאפשרים לשנות מידע לפני שהוא נכנס לשימוש. הבנת שני הקונספטים האלה פותחת את הדלת להתאמה אישית של כמעט כל היבט בוורדפרס – מהתאמות פשוטות ועד התאמות מורכבות של ווקומרס.

המסקנה העיקרית: השתמשו תמיד בהוקים במקום לערוך קבצי ליבה, הוסיפו קידומת להוקים המותאמים שלכם כדי למנוע קונפליקטים, וזכרו שפילטרים חייבים תמיד להחזיר ערך.