כתיבת SHORTCODE

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

[-# POST_LIST id='23' template='gallery_item' #]

סוג התוכן

קיימים מספר אובייקטים של מידע מהם ה SHORTCODE עשוי למשוך מידע:

• PAGE_LIST - מושכת רשימת דפים מקטגוריות דפי אתר
• POST_LIST - מציג רשימת פריטים מתוך המודולים
• MENU - מייצר תפריט מכונן מתוך קטגוריות תפריטים (עפי ההררכיה של הפריטים)
• PAGE_VALUE /PAGE - מושך מידע על דף שנטען לתוך התבנית

פונקציות SHORTCODE קיימות והאפשרויות השונות

• MENU
  • פונקציה: נועדה על מנת להציג מידע/לולאות מקוננות (לולאה בתוך לולאה)
  • שימוש:   
    • יצירת תפריטים עם תתי תפריטים
    • יצירת של מידע המורכבות מקטגוריות ופריטים או תתי קטגוריות ופריטים
  • פרמטרים
    • ID - הקטגוריה ממנה ימשך המידע
    • menu_template - ריפטר העיצוב בו נעשה שימוש
    • loop_type - סוג הלולאה. ישנם 3 סוגי לולאה
      • לולאה על אובייקט תפריט. פרמטר: loopMenu (נוצר אוטומטית כברירת מחדל עבור ID שמשויך לתפריט ולא נדרש לכתוב אותו)
      • לולאה על קטגורית דפים (ללא הגבלת רמות). פרמטר: loopPages (נוצר אוטומטית עבור ID שמשויך לדפים ולא נדרש לכתוב אותו)
      • לולאה על קטגורית מודולים (ללא הגבלת רמות). פרמטר: loopModule (יש להוסיף לפונקציה על מנת שיפעל בצורה זו!)
  • ​​דוגמאות
    • יצירת תפריט על בסיס קטגוריה נבחרת, כולל יצירה של רמות פנימיות

[-# MENU  id='23' menu_template='gallery_item'#]

• שימוש ב- menu repeater בשילוב עם מודולים. משמש לצורך שליפת מודול שמורכב מקטגוריה ותתי קטגוריות. מאפשר תכנות של לולאה בתוך לולאה (בדומה לתפריט):

[-# MENU  id='23' menu_template='gallery_item loop_type=loopModule'#]

• ​​​PAGE_LIST
  • ​פונקציה: שליפת דפים וקטגוריות מדפי אתר
  • שימוש:
    • הצגת רשימת דפים והמידע שלהם
    • הצגת רשימת דפים תחת קטגוריות
  • פרמטרים:
    • id - יש להכניס מספר קטגוריה. המערכת תמשוך את כל הפריטים תחת קטגוריה זו בלבד
    • idWithSub - מושך את כל הפריטים שנמצאים תחת כל התתי קטגוריות של קטגוריית האב. כולל הפריטים בקטגוריית האב (ללא קטגוריות)
    • html_repeater (חובה) - קוד HTML למידע המבוקש, יש לרשום את שם html_repeater  כפי הוא מוגדר בתמה.
    • orderBy=RAND - קוד המאפשר לשלוף פריטים בצורה רנדומלית
    • QuerySelect=DISTINCT  - בשימוש רק בפונקציה idWithSub - יגרום לכך שפריטים שמשויכים למספר קטגוריות יופיעו פעם אחת בלבד (טוב לגלריות סינון)
    • orderBy=date- במידה והוגדר לדף שדה תאריך, ניתן להציג את הדפים ממוינים מהחדש לישן.
  • ​דוגמאות:
    • ​שליפת דפי תוכן עפי קטגוריה:

[-# PAGE_LIST id='23' template='gallery_item' #]

• שליפת דפי תוכן מקטגוריה כולל תתי הקטגוריות שלה, והגבלה ל4 פריטים סהכ

i[-# PAGE_LIST id=34902 html_repeater=article_test orderBy=date #]

• שליפת דפי תוכן מקטגוריה ומיון לפי תאריך

[-# PAGE_LIST idWithSub='23'  template='gallery_item' quantity='4'#]

• שליפת דפי תוכן יחודים (כל פריט פעם אחת) מקטגוריה כולל תתי הקטגוריות שלה

[-# PAGE_LIST idWithSub='26573'  template='Gallery_items' QuerySelect=DISTINCT  #]

• שליפת מידע מדפי תוכן בצורה רנדומלית:

[-# PAGE_LIST id='23' template='gallery_item' orderBy='RAND()' #]

[# PAGE_LIST taxonomyById='40' template='gallery_item'#-] 

• שליפת דף לתוך טמפלט של דף 

[-# PAGE_SINGLE page_id={# PAGE_VALUE name=UNIQ(unq_f_similarProduct1) #-} template='related_products'#]

• POST_LIST 
  • פונקציה: שליפת מידע אודות פריטים ממודול
  • שימוש:
    • הצגת מידע בתוך עמוד (למשל המלצות, גלריה, צוות וכו)
  • פרמטרים:
    • id - יש להכניס קוד קטגוריה. המודול ימשוך את כל הפריטים תחת קטגוריה זו
    • idWithSub - ???
    • taxonomyById -  משיכת כל רשימת הקטגוריות המשנה תחת קטגוריית אב.
    • taxonomyType - יש להכניס את שם הTAXONOMY של המודול (מופיע בURL למעלה של המודול). משיכת כל שמות הקטגוריות הקיימות, מושך שם בלבד ללא הפריטים תחתיו.
    • html_repeater (חובה)  - קוד HTML למידע המבוקש, יש לרשום את שם html_repeater  כפי הוא מוגדר בתמה.
    • postType - משיכת כל הפריטים מאותו סוג מודול (כלומר כל הפריטים מכל הקטגוריות)
    • חשוב ! יש להכניס רק אחד מקודים אלו, או id או postTitle או taxonomyType
    • orderBy=RAND - קוד המאפשר לשלוף פריטים בצורה רנדומלית
  • דוגמאות
    • שליפת פריטי מודולים עפ"י מספר קטגוריה:

[-# POST_LIST id='23' template='gallery_item' #]

• שליפת מידע של כל הפריטים מכל הקטגוריות של מודול מסוים:

[-# POST_LIST postType='gallery_category' template='gallery_item'#]  

• שליפת מידע מקטגוריית מודול כולל תתי הקטגוריות שלה:     

[-# POST_LIST idWithSub=2470  template='recipe_items_new' #]

• שליפת כל תתי הקטגוריות של הקטגוריה הנבחרת (ללא דפים כלל!) 
•  

[-# POST_LIST taxonomyType='gallery_category' template='gallery_item'#]

• שליפת מידע מקטגוריות משנה של קטגוריה

[# POST_LIST taxonomyById='40' template='gallery_item'#-]  

• HTML_SNIPPET
  • פונקציה: שליפה של מקטע קוד בודד מתוך HTML REPEATER . המקטע אינו משויך לדף או למודול כשלהו
  • שימושיות: עבור מקטעי קוד שחוזרים בחלקים שונים: טפסים, קוד שיתוף, הנעה פעולה
  • פרמטרים:
    • name - שם הריפטר שהוא מציג
• CONTENT_AREA
  • פונקציה: שליפת מקטע קוד בודד אשר נמצא באזור CONTENT_AREA. הלקוח יכול לשנות ולערוך קודים באזור זה (בשליטת המתכנת)
  • שימושיות:
    • מקטע קוד בודד בתוך עמוד כגון כותרת מיוחד או ציטוט. אזור זה נגיש לשינוי על הלקוח
  • פרמטרים:
    • name - שם אזור התוכן. אנו נשתמש בשליפה מתוך שם כאשר נרצה לשכפל אתר מסוים (כך לאחר שכפול הקוד יפנה למקום המתאים)
    • id - מספר אזןר התוכן 
• PAGE_VALUE
  • פונקציה: שליפת כל המידע מדף שנבחר. הצגה של שדות בסיס או שדות יחודיות
    • Id
    • Title
    • Thumbnail
    • Excerpt
    • ContentPageUrl
    • pageTermsBySlug
    • pageCategories
    • taxonomyId
    • SideMenu
    • SeoDesc
  • שימוש:
    • הצגה של מידע יחודי אודות דף בתוך הטמפלט
  • דוגמאות:

 [# PAGE_VALUE name=pageCategories   #-]

פרמטרים נוספים שמתאימים למרבית הקודים (מלבד MENU)

• quantity - כמות פריטים מבוקשת. מאפשר להגביל את מספר הפריטים שיוצגו בתגית זו.

דוגמאות כלליות חשובות לSHORTCODE

1. שליפת מידע מדף תוכן בודד שנבחר עי BROWES PAGES

  [-# PAGE_SINGLE page_id={-# PAGE_VALUE name=UNIQ(unq_f_similarProduct3) #} template='related_products' #]