functions

Function: _e  

Description :  

The _e function is used to automate text translation in WordPress using the specified text domain. It is particularly useful for localizing WordPress themes and plugins, allowing WordPress to translate the text displayed in the user interface.  

Example of use:  

You can learn more by referring to the PHP file named _e.php

Settings:  

• $text (string) : The text to translate. This is the text you want to display, which will be translated according to the specified text domain.  

• $domain (string) : The text domain used for translation. It corresponds to the domain text for which translations are available.  

Returns:  

• Translated text : The _e function is a WordPress function that prints the translated text directly. As a Twig function, it returns the translated text instead of printing it.  

[ psourcecode file = 'locales/_e.php' ]

Function: la_photo  

Description :  

The la_photo function is used to retrieve information about a photo in a specific format. This function is particularly useful in the context of Twig to manage and display images on a WordPress site. It takes an image and returns an array containing the image URL, its width and height.  

Use :  

In a context where you need to display an image, la_photo makes it easy by providing you with the image dimensions and URL directly. This is useful to ensure that the image is displayed correctly with the appropriate dimensions.  

Example of use:  

 

You can learn more by referring to the PHP file named la_photo.php  

Settings:  

• photo (required): The image to be processed.  

• size (optional): The format of the image to retrieve (eg. 'large' , 'medium' , 'thumbnail' ).  

Return: A table containing:  

1. The URL of the image.  

1. The width of the image.  

1. The height of the image.  

Notes: This feature is useful for managing images efficiently in your Twig templates, ensuring a display adapted to the specific needs of your site.  

[ psourcecode file = 'locales/ la_photo.php' ]

Function: menu  

Description :  

The menu function generates a navigation menu in HTML format from the menu locations defined in WordPress. It is used in Twig templates to display navigation menus by customizing their appearance and structure.  

Usage: The function is called to display a menu in a specific area of the WordPress site. It supports various parameters to customize the menu display and can include submenus if needed.  

Example of use:  

You can learn more by referring to the PHP file named menu.php  

Settings:  

• $location (required): The location of the menu defined in WordPress (eg. 'primary' ).  

• $class (optional): The CSS class to apply to the menu (eg. "navigation" ).  

• $walker (optional): The walker class used to customize the HTML rendering of the menu (eg. 'yes' to indicate the presence of submenus).  

• $li (optional): HTML to add around the <li> elements of the menu.  

• $a (optional): HTML to add around the <a> elements of the menu.  

Specific parameter:  

• $walker : This parameter is a boolean ( 'yes' or 'no' ) that indicates whether the menu can contain submenus ( 'yes' ) or not ( 'no' ).  

Back :  

• A formatted HTML code to display the navigation menu with the specified options.  

Notes:  

RAW is a filter in Twig used to indicate that content should be displayed as is, without escaping. This means that all HTML contained in the variable or expression will be rendered directly into the HTML output, without being converted to HTML entities.  

[ psourcecode file = 'locales/menu.php' ]