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

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
主站蜘蛛池模板: 河津市| 兰州市| 朝阳区| 光泽县| 宁河县| 正阳县| 青海省| 修水县| 舞阳县| 淮滨县| 安龙县| 边坝县| 绥化市| 肥城市| 荔浦县| 东兴市| 扶沟县| 澳门| 江门市| 和田县| 来凤县| 济阳县| 海门市| 承德县| 博湖县| 北辰区| 峨边| 柯坪县| 时尚| 岑溪市| 喀喇沁旗| 乌鲁木齐市| 庄河市| 察哈| 中方县| 林西县| 永福县| 四子王旗| 德钦县| 天长市| 达孜县|