2017 © Pedro PelĂĄez
 

library theme-lib-content

Collection of content helper functions for WordPress themes

image

mindkomm/theme-lib-content

Collection of content helper functions for WordPress themes

  • Monday, February 19, 2018
  • by gchtr
  • Repository
  • 3 Watchers
  • 0 Stars
  • 176 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 3 Versions
  • 22 % Grown

The README.md

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 = &nbsp;&hellip; ), (*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)

The Versions

19/02 2018

dev-master

9999999-dev

Collection of content helper functions for WordPress themes

  Sources   Download

MIT

The Requires

  • php >=7.0.0

 

19/02 2018

1.0.1

1.0.1.0

Collection of content helper functions for WordPress themes

  Sources   Download

MIT

The Requires

  • php >=7.0.0

 

13/02 2018

1.0.0

1.0.0.0

Collection of content helper functions for WordPress themes

  Sources   Download

MIT

The Requires

  • php >=7.0.0