mindkomm/theme-lib-links

Collection of link helper functions for WordPress themes

Links

Collection of link helper functions for WordPress themes., _(*1)

Installation

You can install the package via Composer:, _(*2)

composer require mindkomm/theme-lib-links

Functions

make_anchor_link

Converts an URL to an anchor link., _(*3)

Prefix the last segment of a URL with a # to use it as an anchor link., _(*4)

make_anchor_link( string $url ), _(*5)

Returns: string The updated URL., _(*6)

PHP, _(*7)

// Output: https://www.mind.ch/onepager#subsection
echo make_anchor_link( 'https://www.mind.ch/onepager/subsection' );

is_external_url

Checks if a URL is external or internal., _(*8)

is_external_url( string $url ), _(*9)

Returns: bool Whether the URL is external., _(*10)

PHP, _(*11)

if ( is_external_url( 'https://example.org' ) ) {
    // Do something
}

Twig, _(*12)

{% if is_external_url('https://www.example.org') %}
    {# Do something #}
{% endif %}

url_to_domain

Converts an URL to just the domain name together with the TLD., _(*13)

url_to_domain( string $url, bool $strip_www = false, int|bool $limit = false ), _(*14)

Returns: string The domain part of the URL., _(*15)

PHP, _(*16)

<?php $domain = 'https://www.mind.ch/post/blablabla?param=wow'; ?>
<a href="<?php echo $url; ?>"><?php echo url_to_domain( $domain ); ?></a>

Twig, _(*17)

{# url = 'https://www.mind.ch/post/blablabla?param=wow' #}
<a href="{{ url }}">{{ url_to_domain(url) }}</a>

get_link_attributes

Gets href attribute for a link tag with proper target and rel attributes., _(*18)

Checks if the URL is internal or external. Adds a target="_blank" for external urls. Inspired by http://stackoverflow.com/a/25090564/1059980. To catch a security vulnerability, the attribute rel="noopener noreferrer" is added, see https://mathiasbynens.github.io/rel-noopener/ for more info., _(*19)

get_link_attributes( string $url ), _(*20)

Returns: string|bool An href attribute with target and rel attributes, when necessary. Returns false if input is empty., _(*21)

PHP, _(*22)

<a <?php echo get_link_attributes( 'https://www.mind.ch/blog' ); ?>>MIND Blog</a>

Twig, _(*23)

<a {{ get_link_attributes(url) }}>MIND Blog</a>

Twig functions

You need Timber to use these functions., _(*24)

• is_external_url
• get_link_attributes
• url_to_domain

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., _(*25)