How do I insert php code into my markdown files

bensonshaji · November 13, 2018, 2:26am

Hello Hugoers

I am struggling to get my php code rendered in a markdown file. Did anyone try to be naughty this way ? I tried many topics from the forum but none of them seemed to work me. Is it because I am trying to include php in markdown file ?

Thanks in advance!! Hugo Rocks at Super Sonic Speeds !!

File - content/_index.md

---
title: ""
date: 2018-11-12T16:58:05Z
draft: false
outputs:
- PHP
---

{{ define "php" }}`
    {{ "<?php" | safeHTML }}
        echo "Hello World";
    {{ "?>" }}
{{ end }}

File - layouts/_default/baseof.php

{{ block "php_code" . }}

{{ end }}
<!doctype html>

ouput

<p>{{ “<?php” | safeHTML }}

echo “Hello World”;

{{ “?>” }}</p>

<!doctype html>

Where am I going wrong ?

zwbetz · November 13, 2018, 2:46am

Since you want to use PHP in your markdown (as opposed to your template), you need to use a shortcode.

Say you named it layouts/shortcodes/php.html.

Define it as:

{{ .Inner | safeHTML }}

Then use it like:

{{< php >}}
<?php echo "<p>Hello World</p>"; ?> 
{{< /php >}}

Note, wrote this from my phone, so it’s untested.

Update: Tested this from my laptop. It works.

bensonshaji · November 13, 2018, 12:36pm

Thanks @zwbetz

Works perfectly fine as you explained.

Is there any way I can inject that php into {{ define “php_code” }} block ?
Basically I want that to come before the <!doctype html>

zwbetz · November 13, 2018, 1:10pm

You would need to edit one of your templates for this.

Do you want it to show on all pages or only one/some?

Also are you using a theme or a custom layout?

bensonshaji · November 13, 2018, 1:22pm

As of now my intention is to include standard php code at the begining of each php page generated by different files from the content directory (markdown files)

I am not using any theme… I am trying to come up with one, which can handle php code as well.

baseof.php

{{- block "php_code" . -}}

{{- end -}}

<!doctype html>

content/_index.md

---

title: ""

date: 2018-11-12T16:58:05Z

draft: false

outputs:

- PHP

---

<!-- some php code in the body tag -->

{{< php >}}
<?php echo "Hello World"; ?>
{{< /php >}}

<!-- other php code that I want in before Doctype -->
{{ define "php_code" }}
<?php echo "Hello Before Doctype html" ?>
{{ end }}

Something like is what I am trying to achieve.

zwbetz · November 13, 2018, 1:32pm

You could do something like this in your baseof.html, which would include this PHP code on every page.

{{ "<?php echo \"Hello Before Doctype html\" ?>" | safeHTML }}
<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
    <title>{{ block "title" . }}
      <!-- Blocks may include default content. -->
      {{ .Site.Title }}
    {{ end }}</title>
  </head>
  <body>
    <!-- Code that all your templates share, like a header -->
    {{ block "main" . }}
      <!-- The part of the page that begins to differ between templates -->
    {{ end }}
    {{ block "footer" . }}
    <!-- More shared code, perhaps a footer but that can be overridden if need be in  -->
    {{ end }}
  </body>
</html>

For a deeper dive checkout the docs on base templates.

bensonshaji · November 13, 2018, 1:41pm

This should work fine for normal use cases. But I was wondering just in case if I had to inject a different php code into that section through different files like [“content/_index.md”, “content/_page1.md”, “content/_page2.md”]

So that this way I can make that code block dynamic which can accept any php code.

I was also going through the readFile option, if it can make the functionality dynamic. For example

baseof.php

{{$file := .Get .Params.php_file }}
{{ $file  | readFile | safeHTML }}

_index.md

---
title: ""
php_file: "/static/class/test.php"
---

Will it work this way… ? Haven’t tested it out though…

bensonshaji · November 13, 2018, 1:46pm

Just tried that code…

Getting this error

execute of template failed: template: index.php:2:12: executing "php_code" at <.Get>: can't evaluate field Get in type *hugolib.PageOutput

Can hugo access files from static directory ?

bensonshaji · November 13, 2018, 2:10pm

@zwbetz

Thanks for the help buddy… I was able to inject the php code using this code block

{{ print .Dir .Params.php_file | readFile | safeHTML }}

<doctype html>

Sadly I couldn’t figure why I can’t run go template code in markdown files i,e

{{- block "php_code" . -}}

{{- end -}}

This functionality is supported by middleman. For ex

In markdown files

<% content_for :php do %>
 // anything
<% end %>

I wish hugo supports this… Or may be I couldn’t figure it out yet.

zwbetz · November 13, 2018, 3:32pm

So, I think you may be confusing how to do this in Template files vs Content files.

As mentioned previously, you can run go template code in markdown (content) files by using a shortcode.

This code snippet below you are referencing, needs the “other pieces” to work. So let’s say you had this snippet in your layouts/_default/baseof.html

{{- block "php_code" . -}}{{- end -}}

You would then need to define it. Let’s say you defined it in your layouts/post/single.html. By doing this, it would be included in all pages of type “post”.

{{- define "php_code" -}}
  <!-- mysterious php things here -->
{{- end -}}

If you instead defined it in your layouts/_default/single.html, it would be included in all single pages/posts.

Make sense?

bensonshaji · November 13, 2018, 3:41pm

Yes it perfectly makes sense and it actually works. I was just wondering if Hugo supports the below code in /content/{ “page-1.md”, “page-2.md” } instead of /layouts/_default/single.html

{{ - define "php_code" - }}
<!-- mysterious php things here LOL :D -->
{{- end -}}

Because right now, when I include the above 3 lines in content/page-1.md, Markdownify seems to be escaping it / sanitizing the special characters.

zwbetz · November 13, 2018, 3:57pm

As far as I know, it does not support that.

But why do you need it? You can do the equivalent thing using a shortcode.

bensonshaji · November 13, 2018, 4:21pm

I actually want page specific php code to execute / check certain conditions before the actual page loads. In order to do that I need to place different php codes at the beginning of the page.

shortcodes will the do the job but i can’t place them in the intended position. (i.e at the beginning of the page instead of including it in the body)

As of now the only thing that supports it is the “block” and “define” from Hugo templates, but only in layouts.

I Think it should be fine for now as I can use shortcodes for the markdown and use Params to readFile and print its content. (This is working for now)

I think Hugo is getting better day by day and I am really amazed with its blazing fast build speeds. I am doing some leisure time testing to make use of this speed to see if I can actually avoid using bulky php frameworks and keep things simple and organized yet dynamic(PHP) using Hugo. To be honest I think Hugo does it well.

Also, Appreciate your support in helping me figure out things. Kudos to you

zwbetz · November 13, 2018, 4:49pm

I see what you are asking now. So there are a few ways to do this

PHP code in front matter param

Let’s say your markdown file has the literal PHP code in its front matter. Notice how the snippet has to be surrounded by quotes since it’s a string, and the inner quotes are escaped.

---
phpcode: "<?php echo \"Hello World\"; ?>"
---

Then in your template you would add this:

{{ with .Params.phpcode }}
  {{- . | safeHTML -}}
{{ end }}

<!doctype html>

By using with, the PHP code is only included if the phpcode param is set in the page’s front matter.

PHP file in front matter param

As you hinted to earlier, you could also reference a PHP file from a front matter param.

Say a file existed at static/file.txt, with contents:

<?php echo "Hello World"; ?>

Then in your page’s front matter:

---
phpfile: "static/file.txt"
---

Then in your template:

{{ with .Params.phpfile }}
  {{- . | readFile | safeHTML -}}
{{ end }}

<!doctype html>

As mentioned, since using with, this will only run if the phpfile param is set in the page’s front matter.

Edit: If you use this way, perhaps don’t name the file with a .php extension, so that it isn’t unintentionally executed.

bensonshaji · November 14, 2018, 1:45pm

Thanks @zwbetz

That sounds promising to resolve my issue. Tested it out a while ago and both option seem to work. This should get me going for couple more days while I scratch my head to test out localization. I hope it would be easier…

Best Regards

Topic		Replies	Views
How can I stop Hugo from escaping out my PHP code in a template file? support	4	1087	March 18, 2019
Is there a way to add php code to template? support	6	2340	November 10, 2018
Hugo markup render <?php to <!--?php support	14	549	May 15, 2021
Create simple shortcode to prevent markdown from rendering HTML support	16	3828	January 18, 2022
Is it possible to insert HTML code in Markdown content? support	7	83278	March 19, 2020

How do I insert php code into my markdown files

File - content/_index.md

File - layouts/_default/baseof.php

ouput

baseof.php

content/_index.md

baseof.php

_index.md

In markdown files

PHP code in front matter param

PHP file in front matter param

Related topics