Content
A collection of content helper functions for WordPress themes., (*1)
Installation
You can install the package via Composer:, (*2)
composer require mindkomm/theme-lib-content
Usage
The content filter
A content
filter that you can use for text that is not the main content., (*3)
{{ post.custom_text|apply_filters('content') }}
Functions
Name |
Summary |
Type |
Returns/Description |
gender |
Gets string by gender. |
string |
lines_to_array |
Turns each line of a text into an array. |
array |
strip_control_characters |
Strips out forbidden Control Characters that came from copy-pasting text into WYSIWYG editor. |
string |
The filtered text. |
truncate_close |
Truncates a text close a certain number of characters. |
string |
Truncated string. |
strip_control_characters
Strips out forbidden Control Characters that came from copy-pasting text into WYSIWYG editor., (*4)
You canât see these Control Characters when you look at the text, yet they can still lead to
unexpected behavior., (*5)
strip_control_characters( string $text )
, (*6)
Returns: string
The filtered text., (*7)
Name |
Type |
Description |
$text |
string |
The text to filter. |
lines_to_array
Turns each line of a text into an array., (*8)
lines_to_array( string $string )
, (*9)
Returns: array
, (*10)
Name |
Type |
Description |
$string |
string |
Multiline string. |
Twig, (*11)
<ul>
{% for line in multiline_text|lines_to_array %}
<li>{{ line }}</li>
{% endfor %}
</ul>
truncate_close
Truncates a text close a certain number of characters., (*12)
This function doesnât cut off words, but only adds the words that still fit into the maximum width., (*13)
truncate_close( string $string, int $desired_width = 200, string $more = … )
, (*14)
Returns: string
Truncated string., (*15)
Name |
Type |
Description |
$string |
string |
String to truncate. |
$desired_width |
int |
Optional. The amount of characters you want to end up with. |
$more |
string |
Optional. The text to append as 'more'. Default is a non-breaking space followed by an ellipsis. |
Twig, (*16)
{{ post.content|truncate_close }}
gender
Gets string by gender., (*17)
Yes, for now, this supports only male and female genders., (*18)
gender( string $male, string $female, string $gender, array $female_identifiers = [] )
, (*19)
Returns: string
, (*20)
Name |
Type |
Description |
$male |
string |
Male representation of string. |
$female |
string |
Female representation of string. |
$gender |
string |
Gender identifier. |
$female_identifiers |
array |
Identifier keys for female representation. Default [ 'f', 'female' ] . |
PHP, (*21)
<?php
echo gender( 'Schreiner', 'Schreinerin', $post->gender );
Twig, (*22)
{{ gender( 'Schreiner', 'Schreinerin', post.gender ) }}
Support
This is a library that we use at MIND to develop WordPress themes. Youâre free to use it, but currently, we donât provide any support., (*23)