官术网_书友最值得收藏!

  • concrete5 Cookbook
  • David Strack
  • 350字
  • 2021-08-13 16:15:55

Getting a page type by its handle

As mentioned in the chapter introduction, page types also have human readable handles, which offer a convenient way of loading page types without knowing their numerical IDs. Handles are always alphanumerical strings with underscores between words, and do not contain any file extensions such as .php. For example, the handle for a page type called "Left Sidebar" would most likely be left_sidebar, but concrete5 lets users specify any alphanumeric string for a handle, so it's possible that the handle for Left Sidebar would also just be left.

You can find the handles of page types by visiting the Page Types area of the concrete5 dashboard, located at /dashboard/pages/types/ on your concrete5 website.

Getting ready

In this recipe, we will be loading a page type with the handle of left_sidebar. Please make sure that page type exists in your concrete5 installation, otherwise you can add a new page type with that handle, or adapt the recipe to work for your situation.

How to do it...

Here's how we would load the page type with a handle of left_sidebar. This is similar to loading a page by its path. The steps are as follows:

  1. Open /config/site_post.php in your preferred code editor.
  2. Declare the handle of the page type that you wish to load.
    $handle = 'left_sidebar';
  3. Load the page type using the handle that we just defined.
    $pageType = CollectionType::getByHandle($handle);
  4. You can verify that you have loaded the page type by dumping the $pageType variable.
    my_debug($pageType);

How it works...

A simple database query is performed, which will return a CollectionType object if it is successful.

There's more...

Just like the warning for loading pages by their paths, you will want to exercise the same good judgment when loading page types by their handles. Since these handles are just strings that can be edited through the concrete5 interface, you will need to make sure that you aren't writing code that could break if one of the site editors changes the handle of a page type.

See also

  • The Getting a page type by its ID recipe
主站蜘蛛池模板: 达孜县| 昌乐县| 宁乡县| 内江市| 象山县| 宜兴市| 平山县| 彰化县| 栾川县| 镶黄旗| 博客| 铜陵市| 伊宁县| 神农架林区| 平陆县| 平阴县| 绥江县| 黄山市| 北海市| 同江市| 正安县| 耿马| 衡山县| 普定县| 平昌县| 长阳| 墨玉县| 二连浩特市| 石棉县| 黄石市| 自贡市| 仁布县| 梁平县| 仙桃市| 德昌县| 苍梧县| 茌平县| 四子王旗| 和平县| 常山县| 车致|