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

Getting a Page object by its path

concrete5 also supports the loading of Page objects by the path that is displayed in the web browser. This is a convenient way to load pages without knowing their numerical ID. In this exercise, we will load an About Us page by its path.

Getting ready

We will be loading a page with the path of /about-us. If this page does not exist in your concrete5 site, please add it to the sitemap before attempting this exercise.

How to do it...

Using a static function called getByPath, we can easily get a Page object without knowing the ID. The steps are as follows:

  1. Open the /config/site-post.php file in your code editor.
  2. Declare the path of the page that you wish to load.
    $path = '/about-us';
  3. We can load the page located at http://example.com/about-us by passing the path string to the getByPath function.
    $aboutPage = Page::getByPath($path);
  4. To make sure we grabbed the correct page, dump the $aboutPage variable to verify that we have a fully loaded Page object. We will use the custom debug function that we created in the chapter introduction.
    my_debug($aboutPage);

How it works...

concrete5 will query the database for the page that has the specified path assigned to it. You will want to use good judgment when loading pages by their paths, as that data can change easily through the concrete5 interface. Imagine that you are working on a site with 15 editors, and any one of them has the ability to edit the path of a page. concrete5 by default will save old page paths whenever a new one is changed, but it is not required. Hard coding page paths in your custom applications should be used only when appropriate. It is a much better idea to load pages by their ID whenever possible, as that ID does not change.

There's more...

You can load any page on the site using this technique. To load a Careers page that exists below the About page that we just loaded, you would write the following:

$careersPage = Page::getByPath('/about-us/careers');

You should know that concrete5 will cache the page IDs related to each path, so if you are experiencing unexpected results while using this function, make sure to clear your site cache by visiting /dashboard/system/optimization/clear_cache/ on your concrete5 website.

See also

  • The Getting the current Page object recipe
  • The Getting a Page object by its ID recipe
主站蜘蛛池模板: 张家港市| 永嘉县| 张家川| 莱州市| 响水县| 普陀区| 仙游县| 梨树县| 沙河市| 崇信县| 神农架林区| 普宁市| 沛县| 观塘区| 沙坪坝区| 邹城市| 河东区| 浏阳市| 绵阳市| 佛学| 宝兴县| 广宗县| 清苑县| 额敏县| 集贤县| 从化市| 同德县| 汾阳市| 南宫市| 泉州市| 金寨县| 平江县| 崇阳县| 孟州市| 张家界市| 津南区| 共和县| 台湾省| 凤凰县| 宁安市| 阿克陶县|